Trademark Acknowledgments Printronix and PSA are registered trademarks of Printronix, Inc. PXML, SL4M, and T4M are trademarks of Printronix, Inc. COPYRIGHT 2006, 2007 PRINTRONIX, INC. All rights reserved.
RFID Statistic Response... 23 Reboot Request ... 24 Information Request ... 25 Information Get Request... 25 Printer Information Response ... 25 Server Information Response ... 27 rfidTagOption Information Response... 27 Printer ACK or Error Response ... 28 PXML Inactive Error Response ... 29...
Page 6
Validate Requests And Responses Using XML Schema ... 45 A New Features In PXML ... 47 Version 2.0... 47 Version 2.1... 47 B Formal PXML Schema ... 49 C Contact Information... 71 Printronix Customer Support Center... 71 Printronix Supplies Department ... 71 Corporate Offices... 72...
• the transport mechanism that moves the messages back and forth between the printer and the client software. The main component of the model is the Printronix XML Device Management Language, which describes the management and response messages. PXML is an XML based language that allows a client application to issue commands to a printer and receive responses from the printer.
The client is responsible for maintaining the TCP management connection to the printer; reconnect as necessary. The management connection may be lost at any time due to printer power-down or network failure. Responses will be lost when the management connection is down since there is no caching or retransmission mechanism.
PXML Selection PrintNet Enterprise (PNE) is the Printronix proprietary management protocol used by the Printronix PrintNet Enterprise software. PXML is the XML based management protocol that serves as a direct interface between third party software. In version 1.0, the printer factory default is PNE, but the user can select which management protocol to use via PTX_SETUP commands or from the front panel.
ETHERNET (if Ethernet is not available, try Adapter if it is CONFIG-PNE_PORT_NUM;value where value selects the active PNE Port Number. NOTE: The printer automatically reboots after this command. CONFIG-PXML_PORT_NUM;value where value selects the active PXML Port Number. NOTE: The printer automatically reboots after this command.
PTX_END Transport The printer provides a TCP server socket that can be opened by a client as a telnet session. Only one socket is allowed to be open at a time. The factory default is port 3001 for PNE protocol and 3007 for PXML protocol.
For information inquiry commands a password is not required. By default the NIC password is zero, or an empty string. To change the NIC password, please refer to the Printronix Network Interface Card User’s Manual . <?xml version=”1.0” encoding="UTF-8"?>...
Status Status When certain events occur, the printer can send status messages to the client as responses to the client’s request or as unsolicited notification. For example, if a fault occurs, messages are sent to inform the client about the fault condition.
Chapter Messaging Get Status Request The client sends the following command to request the printer to send status. <?xml version="1.0" encoding="UTF-8"?> <pxml> <status> <get type="fault"/> </status> </pxml> The type attribute is used to specify the type of status to send, which can include the any of the following: Table 1.
The type attribute is used to specify the type of status reports that are enabled or disabled. Possible options for type include: Table 2. Printer Attribute and Status - Automatic Status Select Attribute display Automatic panel display status. engine Automatic engine status.
Chapter Messaging The end of the job that is not completed successfully is announced by sending the following message: <?xml version="1.0" encoding="UTF-8"?> <pxml> <status> <job type="jobEnd"> <jobDetail id="1234" failure="1"/> </job> </status> </pxml> NOTE: The failure attribute is only sent by PXML version 2.1 or higher. Label Response Message NOTE: Not supported on P7000 printers.
If job version is set to one, rfidTagDetail version=1 is sent by the printer. This message is only sent for writing to EPC field.
Page 18
<rfidTagDetail version="1" failure="false"> </rfidTagDetail> </job> </status> </pxml> The properties for rfidTagDetail version 1 include: Table 3. Printer Attribute and Properties - RFID Tag Response Message, Version 1 Attribute type The tag type description. length The number bits in the raw tag data.
Page 20
Chapter Messaging Table 4. Printer Attribute and Properties - RFID Tag Response Message, Version 2 Attribute length The number of bytes in the data property. operation Read or write. This will not be present in the middle or last chain.
<display row="1" text="MENU MODE"/> </status> </pxml> There are two attributes in the message: Table 5. Printer Attribute and Properties - Display Response Message Attribute The row number, for multiple row displays. The first row is ‘1’. text The text on the row, as seen by the operator.
<pxml> <status> <engine state="idle/> </status> </pxml> There is one attribute in the message: state = The engine state. Possible values include: Table 7. Printer Values and Properties - Engine Status Response Message Values fault idle offline pause printing present Statistics NOTE: Not supported on P7000 printers.
RFID Statistic Clear Request NOTE: This command is not supported on P7000 printers. This request clears the RFID statistics counters in the printer and requires a password. As a result, the RFID read, write, failed, and voided counters start at zero again.
The download port is 3010. Any incoming data is in flash file format. These files have a special header that is recognized by PRINTRONIX printers. This data is loaded into the flash file system of the printer before the printer reboots.
= The type of information. Possible options are printer, server, and rfidTagOption rfidTagOption was added in PXML version 2.1. Printer Information Response This printer information message is sent to a host in response to obtain information for type=printer. <?xml version="1.0" encoding="UTF-8"?> <pxml>...
Page 26
Size of FLASH that is not available, until the printer performs an optimize reboot operation. Total EMC installed (0=not available) EMC available Size of EMC that is not available, until the printer performs an optimize reboot operation. Maximum number of front panel display lines...
Matrics2020 96 RAFUCode 450 96 The number of options available for RFID tags depends on the software version and the RFID reader installed inside the printer. The tag names are unique for all printers. Printer ACK or Error Response Some commands do not return an immediate response, in this case the printer will send an ack message indicating that it received the request.
To activate PXML refer to “PXML Selection” on page 9. This message is only received for PXML version 1.0. For version 2, PNE and PXML can coexist in the printer and UCP does not return any error messages, if it gets PXML messages on its port.
</pxml> Time Set Request An error message is sent back if the time setting is not available in the printer. This request message sets the new time for the printer and requires a password. This is supported by PXML version 2.0 or higher.
More than one network connection may be present, such as embedded (ENET), wireless embedded (WENET), external (XNET) and wireless external (WXNET) options. This printer setting message is sent to a host to obtain setting requests for type=network. Only the network connections (ENET, WENET, XNET, WXNET) that are present in the system have descriptions included in this message.
Page 32
Chapter Messaging An ack message is sent back to indicate whether the request is successful or unsuccessful. <?xml version="1.0"?> <pxml> <setting> <network type="WENET"> <property name="macAddress" value="2345679"/> <property name="DHCPenable" value="1"/> <property name="ipAdrress" <property name="subnetMask" value="255.255.255.255"/> <property name="gatewayAddress" </network> <network type="ENET"> <property name="macAddress" value="2345679"/> <property name="DHCPenable"...
Network Set Request This is supported by version PXML version 2.0 or higher. The network connection needs to set one connection at a time. This request requires a password. IMPORTANT The application needs to send a reboot request to activate the network setup changes.
Messaging RFID Setting Response NOTE: Not supported on P7000 printers. This is supported by PXML version 2.0 or higher. This printer setting message is sent to a host in a response to obtain setting request for type=rfidSetting. <?xml version="1.0"?> <pxml>...
<pxml> <configSetting> <load name="1"/> </configSetting> </pxml> Valid options for name are 1-8, factory, and powerUp. The printer sends an ack message to confirm. Save Configuration Request This request requires a password and is supported by PXML version 2.0 or higher.
Valid options for value is 1-8 or failed. Printer Storage Flash or EMC Storage Request This is supported by PXML version 2.0 or higher. This printer setting message is sent to a host in response to obtain setting request for type=flash or emc. <?xml version="1.0" encoding="UTF-8"?>...
<storage> <emc type="unprotected"> <file name="form1.pgl" <file name="form2.pgl" </emc> </storage> </pxml> If no EMC is available in the printer, the following will be returned. Since EMC is optional storage, no error message generates. <?xml version="1.0" encoding="UTF-8"?> <pxml> <storage> </storage> </pxml> Flash or EMC Delete File Request This is supported by PXML version 2.0 or higher.
Flash or EMC Read File Request This feature is supported by PXML version 2.1 or higher. The request is sent to read or upload a single unprotected file from the given storage type. This request requires a password. <pxml password="password"> <storage type="flash">...
(applies to P7000 printers only) Buffer Overflow Platen Is Open (applies to P7000 printers only) Printer Is Hot Platen Open Error Has Timed Out (applies to P7000 printers only) Flash File System Is Full Flash File System Needs More DRAM...
Page 41
Printer State Barcode Fails Specification PPM Generated Fault Table 12. SL5000r/T5000r Alerts Printer State Ribbon Fault Print Head Is Hot EC Software Fail Gap Is Not Detected Ribbon Installed In Direct Mode Cutter Has Fault Barcode Fails Specification Missing Barcode...
Page 42
RFID Max. Tag Retry Timeout RFID Tag Failed Timeout RFID Data Error RFID Read Only Tag RFID Lock not supported RFID MAX RETRY Dumping Form Table 13. SL4M™/T4M™ Alerts Printer State Invalid EMC Installed EMC Not Found EMC Write Err EMC Removed...
Page 43
Printer State Paper Out Paper Jam Ribbon Ink Out Power Stacker Jammed Power Stacker Fault Ribbon Ink Out Timeout Firmware Error Hammer Coil Open Shuttle Jam Error Exhaust Fan Fault Hammer Bank Fan Fault Power Supply Voltage Failure Power Supply 8.5V Fail...
Page 44
Chapter Alerts Printer State Illegal Operand Access Illegal Instruction Access Illegal External Bus Access A To D Overrun Undefined Interrupt TCB Corrupted Access Null Pointer Paper Not At Speed Paper Not Scheduled Paper Busy Too Long Paper FIFO Overflow Paper FIFO Underflow...
Validate Requests And Responses Using XML Schema Use the following declaration to validate a PXML command instance against the PXML schema. Below is an example of a normal command that a client sends to the printer: <?xml version="1.0"?> <pxml> <info>...
Page 46
Chapter Validate Requests And Responses Using XML Schema...
Get PXML version (see page 27). • Get response when any RFID setting is changed (see page 29). • Get time from printer’s clock (see page 30). • Set time on printer’s clock (see page 30). • Set network parameter (see page 31).
Page 51
<xsd:attribute name="row" type="xsd:integer" use="optional"/> <xsd:attribute name="column" type="xsd:integer" use="optional"/> <xsd:attribute name="message" type="xsd:string" use="required"/> </xsd:complexType> <xsd:complexType name="rebootType"> <xsd:annotation> <xsd:documentation> <doc:purpose> Reboot the printer with the option of downloading a flash file. </doc:purpose> <doc:type node="request"/> <doc:restriction> Password required. </doc:restriction> <doc:parameter name="type"> Specifies the reboot type. This can be either a normal reset, or can reboot into download mode.
Page 55
<xsd:element name="job" type="jobStatusType"/> </xsd:choice> </xsd:complexType> <xsd:complexType name="getStatusType"> <xsd:annotation> <xsd:documentation> <doc:purpose> Request the printer to send current status. </doc:purpose> <doc:type node="request"/> <doc:parameter name="type"> Indicates the type of status to be returned. </doc:parameter> <doc:parameter name="version"> Indicates the version of response for job status.
Page 56
</xsd:restriction> </xsd:simpleType> </xsd:attribute> <xsd:attribute name="enable" type="xsd:boolean"/> </xsd:complexType> <xsd:enumeration value="display"/> <xsd:enumeration value="fault"/> <xsd:enumeration value="engine"/> Request the printer select unsolicited operation. Indicates the type of unsolicited status. Indicates if unsolicited responses should be sent. <xsd:enumeration value="display"/> <xsd:enumeration value="fault"/> <xsd:enumeration value="engine"/> <xsd:enumeration value="job"/>...
Page 57
<xsd:complexType name="displayStatusType"> <xsd:annotation> <xsd:documentation> <doc:purpose> Object that contains operator panel display text. </doc:purpose> <doc:type node="response" unsolicited="true"/> <doc:parameter name="text"> The displayed text. </doc:parameter> <doc:parameter name="row"> Which text row, for multi-line display. </doc:parameter> </xsd:documentation> </xsd:annotation> <xsd:attribute name="text"> <xsd:simpleType> <xsd:restriction base="xsd:string"> <xsd:minLength value="1"/> <xsd:maxLength value="16"/>...
Page 64
<xsd:attribute name="type"> <xsd:simpleType> <xsd:restriction base="xsd:string"> </xsd:restriction> </xsd:simpleType> </xsd:attribute> <xsd:attribute name="enable" type="xsd:boolean"/> </xsd:complexType> Object reports rfid setting. Describes a printer property. Request the printer select unsolicited operation. Indicates the type of unsolicited setting. Indicates if unsolicited responses should be sent. <xsd:enumeration value="rfidSetting"/>...
Page 67
<xsd:element name="delete" type="deleteStorageType"/> <xsd:element name="flash" type="flashStorageType"/> </xsd:choice> <xsd:attribute name="type"> <xsd:simpleType> <xsd:restriction base="xsd:string"> <xsd:enumeration value="flash"/> </xsd:restriction> </xsd:simpleType> </xsd:attribute> </xsd:complexType> <xsd:complexType name="getStorageType"> <xsd:annotation> <xsd:documentation> <doc:purpose> Object requests directory of a particular type. </doc:purpose> <doc:type node="request"/> <doc:parameter name="type"> Indicates the type of storage information to be returned.
Page 68
<xsd:documentation> <doc:purpose> </doc:purpose> <doc:type node="reply"/> <doc:parameter name="type"> Object requests to upload an unprotected file from printer. Object reports the flash directory of some type. Indicates the type of storage information to be returned. Indicates the file information. <xsd:enumeration value="unprotected"/> Object reports the emc directory of some type.
Page 69
Indicates the type of storage information to be returned. </doc:parameter> <doc:parameter name="file"> Indicates the file information. </doc:parameter> </xsd:documentation> </xsd:annotation> </xsd:choice minOccurs="1" maxOccurs="unbounded"> <xsd:element name="file" type="fileStorageType"/> </xsd:choice> <xsd:attribute name="type" use="optional"> </xsd:choice> <xsd:attribute name="type" use="optional"> <xsd:simpleType> <xsd:restriction base="xsd:string"> <xsd:enumeration value="unprotected"/> </xsd:restriction> </xsd:simpleType> </xsd:attribute>...
Americas Europe, Middle East, and Africa Asia Pacific http://www.printronix.com/support.aspx Printronix Supplies Department Contact the Printronix Supplies Department for genuine Printronix supplies. Americas Europe, Middle East, and Africa Asia Pacific http://www.printronix.com/supplies-parts.aspx (714) 368-2686 (31) 24 6489 311...
NL-6600 Ad Wijchen The Netherlands Phone: (31) 24 6489489 Fax: (31) 24 6489499 Printronix Schweiz GmbH 42 Changi South Street 1 Changi South Industrial Estate Singapore 486763 Phone: (65) 6542 0110 Fax: (65) 6546 1588 Visit the Printronix web site at www.printronix.com...
Page 73
Alerts, 40 general, 40, 42 thermal, 41 Automatic Status Select, 14 display response message, 21 engine status response message, 22 fault response message, 21 job status reply message, 15 label response message, 16 RFID tag response message, 17 Constraints, 8 Contact information, 71 Customer Support Center, 71 Display Response Message, 21...
Page 74
31 PGL error handling response, 30 PGL error handling set request, 31 printer setting get request, 29 printer setting select request for rfidSetting, 29 RFID set request, 34 RFID setting response, 34 time set request, 30 time setting response, 30...
Page 75
Time Set Request, 30 Time Setting Response, 30 Transport, 11 Validate Requests, XML Schema, 45 Validate Responses, XML Schema, 45 XML Schema, validate requests and responses, 45...
Need help?
Do you have a question about the SL4M and is the answer not in the manual?
Questions and answers