com.zebra.sdk.common.card.device

Interface DeviceUtil

All Known Subinterfaces:

ZebraCardPrinter, ZebraPrinterZmotif, ZebraPrinterZxp

public interface DeviceUtil

Defines functions used for printer related operations.

Method Summary

Methods

Modifier and Type	Method and Description
AlarmInfo	checkForAlarm() Gets the printer's current alarm code.
void	clearOCPDisplay(boolean lockOCP) Clears any custom line data from the OCP and returns it to the main view. ZXP Series 1 and 3 and ZMotif series 7, 8, and 9 printers only.
CardCountInfo	getCardCount() Returns the printer's total card count values.
MagneticEncoderInfo	getMagneticEncoderConfiguration() Returns the printer's magnetic encoder configuration.
java.util.List<MediaInfo>	getMediaInformation() Returns a List of the printer's installed media information.
OCPDisplayInfo	getOCPDisplay() Returns the line data currently displayed on the printer's OCP. ZXP Series 1 and 3 and ZMotif series 7, 8, and 9 printers only.
TransferType	getPrintCapability() Returns the transfer type of the printer.
PrinterInfo	getPrinterInformation() Returns the printer's specific device information.
PrinterStatusInfo	getPrinterStatus() Returns the printer's current status information.
java.util.Map<String,String>	getSensorStates() Returns the printer's sensor states.
java.util.Map<String,String>	getSensorValues() Returns the printer's sensor values.
SmartCardInfo	getSmartCardConfiguration() Deprecated. use getSmartCardConfigurations()
java.util.Map<String,String>	getSmartCardConfigurations() Returns the printer's smart card configuration.
boolean	hasLaminator() Returns true if printer includes a laminator.
boolean	hasMagneticEncoder() Returns true if printer includes magnetic encoder
boolean	hasSmartCardEncoder() Returns true if printer includes a smart card encoder.
void	registerAlarmHandler(AlarmHandler alarmHandler) Registers a callback routine for asynchronous reporting of printer alarm conditions.
void	reset() Resets the printer.
void	setOCPDisplay(OCPDisplayInfo ocpDisplay) Displays the specified line data on the printer's OCP. ZXP Series 1 and 3 and ZMotif series 7, 8, and 9 printers only.
void	updateFirmware(String firmwareFilePath) Updates the printers firmware.
void	updateFirmware(String firmwareFilePath, CardFirmwareUpdateHandler handler) Updates the printers firmware.

Method Detail

checkForAlarm

AlarmInfo checkForAlarm()
                        throws ConnectionException,
                               ZebraCardException

Gets the printer's current alarm code.

Returns:

printer alarm code.

• Refer to ZebraCardErrors for list of error codes and descriptions

Throws:

ConnectionException - if their is an error communicating with the printer.

ZebraCardException - if the device is busy.

clearOCPDisplay

void clearOCPDisplay(boolean lockOCP)
                     throws ConnectionException,
                            SettingsException,
                            ZebraCardException

Clears any custom line data from the OCP and returns it to the main view.
ZXP Series 1 and 3 and ZMotif series 7, 8, and 9 printers only.

Parameters:

lockOCP - true to lock the printer's OCP display.

Throws:

ConnectionException - if there is an error communicating with the printer.

SettingsException - if an error occurs while clearing the OCP display.

ZebraCardException - if the printer model is not supported or the device is busy.

getCardCount

CardCountInfo getCardCount()
                           throws ConnectionException,
                                  SettingsException,
                                  ZebraCardException

Returns the printer's total card count values.

Returns:

instance populated with the printer's card count information.

Throws:

ConnectionException - if there is an error communicating with the printer.

SettingsException - if an error occurs while retrieving the card count.

ZebraCardException - if the device is busy.

getMagneticEncoderConfiguration

MagneticEncoderInfo getMagneticEncoderConfiguration()
                                                    throws ConnectionException,
                                                           SettingsException,
                                                           ZebraCardException

Returns the printer's magnetic encoder configuration.

Returns:

instance populated with the printer's installed magnetic encoder configuration.

Throws:

ConnectionException - if there is an error communicating with the printer.

SettingsException - if an error occurs while retrieving the magnetic encoder configuration.

ZebraCardException - if the device is busy.

getOCPDisplay

OCPDisplayInfo getOCPDisplay()
                             throws ConnectionException,
                                    SettingsException,
                                    ZebraCardException

Returns the line data currently displayed on the printer's OCP.
ZXP Series 1 and 3 and ZMotif series 7, 8, and 9 printers only.

Returns:

instance populated with the printer's OCP line data.

Throws:

ConnectionException - if there is an error communicating with the printer.

SettingsException - if an error occurs while retrieving the OCP display information.

ZebraCardException - if the printer model is not supported or the device is busy.

getPrinterInformation

PrinterInfo getPrinterInformation()
                                  throws ConnectionException,
                                         SettingsException,
                                         ZebraCardException

Returns the printer's specific device information.

Returns:

instance populated with the printer specific information.

Throws:

ConnectionException - if there is an error communicating with the printer.

SettingsException - if an error occurs while retrieving the printer information.

ZebraCardException - if the device is busy.

getPrinterStatus

PrinterStatusInfo getPrinterStatus()
                                   throws ConnectionException,
                                          SettingsException,
                                          ZebraCardException

Returns the printer's current status information.

Returns:

instance populates with the printer's status information.

Throws:

ConnectionException - if there is an error communicating with the printer.

SettingsException - if an error occurs while retrieving the printer's status.

ZebraCardException - if the device is busy.

getMediaInformation

java.util.List<MediaInfo> getMediaInformation()
                                              throws ConnectionException,
                                                     SettingsException,
                                                     ZebraCardException

Returns a List of the printer's installed media information.

Returns:

list of MediaInfo instance/s populated with the printer's installed media information.

Throws:

ConnectionException - if there is an error communicating with the printer.

SettingsException - if an error occurs while retrieving the media information.

ZebraCardException - if the device is busy.

getSensorStates

java.util.Map<String,String> getSensorStates()
                                             throws ConnectionException,
                                                    SettingsException,
                                                    ZebraCardException

Returns the printer's sensor states.

Returns:

map of the printer's various sensor names and states.

Throws:

ConnectionException - if there is an error communicating with the printer.

SettingsException - if an error occurs while retrieving sensor states.

ZebraCardException - if the device is busy.

getSensorValues

java.util.Map<String,String> getSensorValues()
                                             throws ConnectionException,
                                                    SettingsException,
                                                    ZebraCardException

Returns the printer's sensor values.

Returns:

map of the printer's various sensor names and values.

• Key = sensor name
• Value = sensor value

Throws:

ConnectionException - if there is an error communicating with the printer.

SettingsException - if an error occurs while retrieving the sensor values.

ZebraCardException - if the device is busy.

getSmartCardConfiguration

@Deprecated
SmartCardInfo getSmartCardConfiguration()
                                        throws ConnectionException,
                                               SettingsException,
                                               ZebraCardException

Deprecated. use getSmartCardConfigurations()

Returns the printer's smart card configuration.
ZXP Series 1 and 3 and ZMotif series 7, 8, and 9 printers only.

Returns:

instance populated with the printer's installed smart card configuration.

Throws:

ConnectionException - if there is an error communicating with the printer.

SettingsException - if an error occurs while retrieving the printer.

ZebraCardException - if the printer model is invalid or if the device is busy.

getSmartCardConfigurations

java.util.Map<String,String> getSmartCardConfigurations()
                                                        throws ConnectionException,
                                                               SettingsException,
                                                               ZebraCardException

Returns the printer's smart card configuration.

Returns:

instance populated with the printer's installed smart card configuration.

Throws:

ConnectionException - if there is an error communicating with the printer.

SettingsException - if an error occurs while retrieving the printer.

ZebraCardException - if the device is busy.

registerAlarmHandler

void registerAlarmHandler(AlarmHandler alarmHandler)

Registers a callback routine for asynchronous reporting of printer alarm conditions.

Parameters:

alarmHandler - An instance that is used to handle printer alarm conditions.

reset

void reset()
           throws ConnectionException,
                  ZebraCardException

Resets the printer.

Throws:

ConnectionException - if there is an error communicating with the printer.

ZebraCardException - if the device is busy.

setOCPDisplay

void setOCPDisplay(OCPDisplayInfo ocpDisplay)
                   throws ConnectionException,
                          SettingsException,
                          ZebraCardException

Displays the specified line data on the printer's OCP.
ZXP Series 1 and 3 and ZMotif series 7, 8, and 9 printers only.

Parameters:

ocpDisplay - an instance populated with the OCP line data to be displayed.

Throws:

ConnectionException - if there is an error communicating with the printer.

SettingsException - if an error occurs while retrieving the printer's OCP display information.

ZebraCardException - if the printer model is not supported, there is a printer error, or ocpDisplay is invalid.

updateFirmware

void updateFirmware(String firmwareFilePath)
                    throws java.io.FileNotFoundException,
                           ConnectionException,
                           ZebraCardException

Updates the printers firmware.

Parameters:

firmwareFilePath - full path to the firmware file.

Throws:

java.io.FileNotFoundException - if the firmwareFilePath is not found.

ConnectionException - if there is an error communicating with the printer.

ZebraCardException - if there is a printer error or firmwareFilePath is invalid.

updateFirmware

void updateFirmware(String firmwareFilePath,
                  CardFirmwareUpdateHandler handler)
                    throws ConnectionException,
                           DiscoveryException,
                           java.util.concurrent.TimeoutException,
                           java.io.FileNotFoundException,
                           ZebraCardException

Updates the printers firmware.

Parameters:

firmwareFilePath - Full path to the firmware file.

handler - Callback for firmware status updates.

Throws:

ConnectionException - if there is an error communicating with the printer.

DiscoveryException - if attempting to reconnect fails.

java.io.FileNotFoundException - if the firmwareFilePath is not found.

java.util.concurrent.TimeoutException - if the firmware update times out.

ZebraCardException - if there is a printer error or firmwareFilePath is invalid.

hasMagneticEncoder

boolean hasMagneticEncoder()
                           throws ConnectionException,
                                  SettingsException,
                                  ZebraCardException

Returns true if printer includes magnetic encoder

Returns:

true if the printer has a Magnetic Encoder.

Throws:

ConnectionException - if there is an error communicating with the printer.

SettingsException - if an error occurs while retrieving the printer's configuration information.

ZebraCardException - if the device is busy.

getPrintCapability

TransferType getPrintCapability()
                                throws ConnectionException,
                                       SettingsException,
                                       ZebraCardException

Returns the transfer type of the printer.

Returns:

the transfer type of the printer.

Throws:

ConnectionException - if there is an error communicating with the printer.

SettingsException - if an error occurs while retrieving the printer's transfer type.

ZebraCardException - if the device is busy.

hasLaminator

boolean hasLaminator()
                     throws ConnectionException,
                            SettingsException,
                            ZebraCardException

Returns true if printer includes a laminator.

Returns:

true if printer configuration includes a laminator.

Throws:

ConnectionException - if there is an error communicating with the printer.

SettingsException - if an error occurs while retrieving the printer's configuration information.

ZebraCardException - if the device is busy.

hasSmartCardEncoder

boolean hasSmartCardEncoder()
                            throws ConnectionException,
                                   SettingsException,
                                   ZebraCardException

Returns true if printer includes a smart card encoder.

Returns:

true if printer configuration includes a smart card encoder.

Throws:

ConnectionException - if there is an error communicating with the printer.

SettingsException - if an error occurs while retrieving the printer's configuration information.

ZebraCardException - if the device is busy.