UniPRT SDK v1.0.0.0
 
Loading...
Searching...
No Matches
PrinterMonitor.PrinterMonitor Class Reference

Public Member Functions

 __init__ (self, connection=None, mgmt_comm=None, comm_descriptor=None)
 Initializes a new instance with the given TCP, JSON, and communication descriptor object.
 
 get_fault_status (self)
 Query the printer for fault status.
 
 get_printer_info (self)
 Get printer information.
 
 get_engine_status (self)
 Query the printer for the engine status.
 
 set_engine_status_listening (self, value)
 Sets whether engine status listening is enabled.
 
 set_display_status_listening (self, value)
 Sets whether display status listening is enabled.
 
 set_alert_status_listening (self, value)
 Sets whether alert status listening is enabled.
 

Public Attributes

 my_mgmt_id
 
 engine_status_listening
 
 listenerCTS
 

Constructor & Destructor Documentation

◆ __init__()

PrinterMonitor.PrinterMonitor.__init__ ( self,
connection = None,
mgmt_comm = None,
comm_descriptor = None )

Initializes a new instance with the given TCP, JSON, and communication descriptor object.

Parameters
connectionThe TCP communication object.
mgmt_commThe JSON communication object.
comm_descriptorThe communication descriptor.
Returns
An initialized instance of PrinterMonitor, or nil if the object could not be created.

Member Function Documentation

◆ get_engine_status()

PrinterMonitor.PrinterMonitor.get_engine_status ( self)

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.

Returns
A string representing the engine status.

◆ get_fault_status()

PrinterMonitor.PrinterMonitor.get_fault_status ( self)

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.

Returns
An array of strings representing the fault status.

◆ get_printer_info()

PrinterMonitor.PrinterMonitor.get_printer_info ( self)

Get printer information.

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

Implemented in PrinterMonitor.

Returns
A PrinterInfo object containing the printer information.

◆ set_alert_status_listening()

PrinterMonitor.PrinterMonitor.set_alert_status_listening ( self,
value )

Sets whether alert status listening is enabled.

Parameters
valueYES to enable listening, NO to disable.

◆ set_display_status_listening()

PrinterMonitor.PrinterMonitor.set_display_status_listening ( self,
value )

Sets whether display status listening is enabled.

Parameters
valueYES to enable listening, NO to disable.

◆ set_engine_status_listening()

PrinterMonitor.PrinterMonitor.set_engine_status_listening ( self,
value )

Sets whether engine status listening is enabled.

Parameters
valueYES to enable listening, NO to disable.

Member Data Documentation

◆ engine_status_listening

PrinterMonitor.PrinterMonitor.engine_status_listening

◆ listenerCTS

PrinterMonitor.PrinterMonitor.listenerCTS

◆ my_mgmt_id

PrinterMonitor.PrinterMonitor.my_mgmt_id

The documentation for this class was generated from the following file: