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

Public Member Functions

string GetEngineStatus ()
 Query the printer for the engine status. More...
 
string[] GetFaultStatus ()
 Query the printer for fault status. More...
 
PrinterInfo GetPrinterInfo ()
 Get printer information. More...
 

Properties

AlertStatusNotice AlertStatusCallback [get, set]
 Holds the function to call when fault/alert messages are received from the printer. Function must match the signature of AlertStatusNotice.
 
bool AlertStatusListening [get, set]
 Enable/disable listening/parsing unsolicited fault status alerts from printer. More...
 
DisplayStatusNotice DisplayStatusCallback [get, set]
 Holds the function to call when display text messages are received from the printer. Function must match the signature of DisplayStatusNotice.
 
bool DisplayStatusListening [get, set]
 Enable/disable listening/parsing unsolicited front panel display text from printer. More...
 
EngineStatusNotice EngineStatusCallback [get, set]
 Holds the function to call when engine status is received from the printer. Function must match the signature of EngineStatusNotice.
 
bool EngineStatusListening [get, set]
 Enable/disable listening/parsing unsolicited engine status from printer. More...
 

Member Function Documentation

◆ GetEngineStatus()

string UniPRT.Sdk.Monitor.IPrinterMonitor.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 UniPRT.Sdk.Monitor.PrinterMonitor.

◆ GetFaultStatus()

string [] UniPRT.Sdk.Monitor.IPrinterMonitor.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 UniPRT.Sdk.Monitor.PrinterMonitor.

◆ GetPrinterInfo()

PrinterInfo UniPRT.Sdk.Monitor.IPrinterMonitor.GetPrinterInfo ( )

Get printer information.

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

Implemented in UniPRT.Sdk.Monitor.PrinterMonitor.

Property Documentation

◆ AlertStatusListening

bool UniPRT.Sdk.Monitor.IPrinterMonitor.AlertStatusListening
getset

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

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

◆ DisplayStatusListening

bool UniPRT.Sdk.Monitor.IPrinterMonitor.DisplayStatusListening
getset

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 the printer.

◆ EngineStatusListening

bool UniPRT.Sdk.Monitor.IPrinterMonitor.EngineStatusListening
getset

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

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