UniPRT SDK  v1.0.0.0
IPrinterMonitor Interface Reference
Inheritance diagram for IPrinterMonitor:
PrinterMonitor

Public Member Functions

AlertStatusNotice GetAlertStatusCallback ()
 
boolean GetAlertStatusListening ()
 
DisplayStatusNotice GetDisplayStatusCallback ()
 
boolean GetDisplayStatusListening ()
 
String GetEngineStatus ()
 Query the printer for the engine status. More...
 
EngineStatusNotice GetEngineStatusCallback ()
 
boolean GetEngineStatusListening ()
 
String[] GetFaultStatus ()
 Query the printer for fault status. More...
 
PrinterInfo GetPrinterInfo ()
 Get printer information. More...
 
void SetAlertStatusCallback (AlertStatusNotice callback)
 Holds the function to call when fault/alert msgs received from printer. Function must match signature of AlertStatusNotice.
 
void SetAlertStatusListening (boolean listening)
 Enable/disable listening/parsing unsolicited fault status alerts from printer. More...
 
void SetDisplayStatusCallback (DisplayStatusNotice callback)
 Holds the function to call when display text msgs received from printer. Function must match signature of DisplayStatusNotice.
 
void SetDisplayStatusListening (boolean listening)
 Enable/disable listening/parsing unsolicited front panel display text from printer. More...
 
void SetEngineStatusCallback (EngineStatusNotice callback)
 Holds the function to call when engine status received from printer. Function must match signature of EngineStatusNotice.
 
void SetEngineStatusListening (boolean listening)
 Enable/disable listening/parsing unsolicited engine status from printer. More...
 

Member Function Documentation

◆ GetEngineStatus()

String GetEngineStatus ( )

Query the printer for the engine status.

Engine status is useful to check if printer is in a state that can print before sending a print job. The string returned is any of the "fault", "idle", "offline", "pause", "printing", "present" (Label Present).

Implemented in PrinterMonitor.

◆ GetFaultStatus()

String [] GetFaultStatus ( )

Query the printer for fault status.

Fault status is used to check if printer is in a fault state that needs attention or may prevent processing of any print job. The alert string array returned represents the alert number sent by printer at alert[0] and brief description at alert[1]. e.g. "2418" represents a "Print Head Open" alert. alert[0] = "2418"; alert[1] = "Print Head Open";

Implemented in PrinterMonitor.

◆ GetPrinterInfo()

PrinterInfo GetPrinterInfo ( )

Get printer information.

Useful for cases where want to check model, firmware version, options installed and other hardware specific details.

Implemented in PrinterMonitor.

◆ SetAlertStatusListening()

void SetAlertStatusListening ( boolean  listening)

Enable/disable listening/parsing unsolicited fault status alerts from printer.

Note that this must be enabled in order to receive any notifications, AlertStatusCallback, from printer.

Implemented in PrinterMonitor.

◆ SetDisplayStatusListening()

void SetDisplayStatusListening ( boolean  listening)

Enable/disable listening/parsing unsolicited front panel display text from printer.

Note that this must be enabled in order to receive any notifications, DisplayStatusCallback, from printer.

Implemented in PrinterMonitor.

◆ SetEngineStatusListening()

void SetEngineStatusListening ( boolean  listening)

Enable/disable listening/parsing unsolicited engine status from printer.

Note that this must be enabled in order to receive any notifications, EngineStatusCallback, from printer.

Implemented in PrinterMonitor.