Module to facilitate listening/retrieval of printer unsolicited messaging or retrieval of printer status/information. More...
Public Member Functions | |
delegate void | AlertStatusNotice (string[] alert) |
Delegate function signature type for setting the callback for fault/alert change notice. More... | |
delegate void | DisplayStatusNotice (string[] displayLines) |
Delegate function signature type for setting the callback for front panel change notice. More... | |
void | Dispose () |
delegate void | EngineStatusNotice (string engineState) |
Delegate function signature type for setting the callback for engine status change notice. More... | |
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... | |
Protected Member Functions | |
virtual void | Dispose (bool disposing) |
Properties | |
AlertStatusNotice | AlertStatusCallback [getset] |
Holds the function to call when fault/alert msgs received from printer. Function must match signature of AlertStatusNotice. | |
bool? | AlertStatusListening [getset] |
enable/disable listening/parsing unsolicited fault status alerts from printer More... | |
DisplayStatusNotice | DisplayStatusCallback [getset] |
Holds the function to call when display text msgs received from printer. Function must match signature of DisplayStatusNotice. | |
bool? | DisplayStatusListening [getset] |
enable/disable listening/parsing unsolicited front panel display text from printer More... | |
EngineStatusNotice | EngineStatusCallback [getset] |
Holds the function to call when engine status received from printer. Function must match signature of EngineStatusNotice. | |
bool? | EngineStatusListening [getset] |
enable/disable listening/parsing unsolicited engine status from printer More... | |
Module to facilitate listening/retrieval of printer unsolicited messaging or retrieval of printer status/information.
Unsolicted messages, if enabled on printer, can be sent at any time. This module requires a constant connection to the printer's management port in order to listen for any messaging sent out by printer.
Result after causing fault by opening/closing print head, and pressing the pause button on printer to place printer "offline"/"online".
delegate void AlertStatusNotice | ( | string[] | alert | ) |
Delegate function signature type for setting the callback for fault/alert change notice.
The alert string array passsed in 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";
delegate void DisplayStatusNotice | ( | string[] | displayLines | ) |
Delegate function signature type for setting the callback for front panel change notice.
The displayLines passsed is a string array with each entry representing a text line on display.
e.g. displayLines[0] = 1st text line on display, displayLines[1] = 2nd text line on display
delegate void EngineStatusNotice | ( | string | engineState | ) |
Delegate function signature type for setting the callback for engine status change notice.
The engineState passsed in is any of the "fault", "idle", "offline", "pause", "printing", "present" (Label Present).
|
inline |
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).
|
inline |
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";
|
inline |
Get printer information.
Useful for cases where want to check model, firmware version, options installed and other hardware specific details.
|
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 printer.
|
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 printer.
|
getset |
enable/disable listening/parsing unsolicited engine status from printer
Note that this must be enabled in order to receive any notifications, EngineStatusCallback, from printer.