Zebra® KR203 Kiosk Receipt Printer Software Integrator Guide P1028248-001 Rev.
© 2010 ZIH Corp. The copyrights in this manual and the software and/or firmware in the printer described therein are owned by ZIH Corp. Unauthorized reproduction of this manual or the software and/or firmware in the printer may result in imprisonment of up to one year and fines of up to $10,000 (17 U.S.C.506). Copyright violators may be subject to civil liability. This product may contain ZPL®, ZPL II®, and ZebraLink™ programs; Element Energy Equalizer® Circuit; E3®; and Monotype Imaging fonts.
Contents Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 Who Should Use This Document. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . How This Document Is Organized . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Contacts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
2 Contents Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 Status Light Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Application LED States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Application User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Print Quality Problems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1 Introduction Who Should Use This Document This guide is intended for use by any person who needs to setup software for use with the KR203 printer. How This Document Is Organized The manual is set up as follows: Introduction Contact information, document conventions. Windows Driver Installation, documentation, preferences, and properties. Troubleshooting Status Light description, User Interface, Error Handling, and fixes to common printing problems.
2 Introduction Contacts Contacts Technical Support via the Internet is available 24 hours per day, 365 days per year. Web Site: www.zebra.com E-mail Back Technical Library: • E-mail address: emb@zebra.com • Subject line: Emaillist Self Service Knowledge Base: www.zebra.com/knowledgebase Online Case Registration: www.zebra.
Introduction Document Conventions Document Conventions The following conventions are used throughout this document to convey certain information: Alternate Color – Cross-references contain links to other sections in this guide. If you are viewing this guide online, click the blue text to jump to its location. Important • Advises you of information that is essential to complete a task. Note • Indicates information that emphasizes or supplements important points of the main text.
4 Introduction Document Conventions P1028248-001 Rev.
2 Windows Driver Description The Windows driver is the only method of communicating with the printer. The driver’s functions also include: the rendering engine, user interface, and a language monitor for reporting printer functions. The driver interface includes tools for updating the printer firmware, checking and printing configuration status, and setting up for different types of media. The driver currently runs on Windows XP, Windows Vista, Windows 7, Windows Server 2003, and Windows Server 2008.
6 Windows Driver Installation Installation Driver Installation Important • To update the driver to a newer version it is recommended that any previous version be removed prior to updating. Refer to "Uninstall" on page 11. Note • Make sure you download the latest driver from the Zebra website (see "Contacts" on page 2). The driver will be downloaded as a ZIP file - you will need an extraction utility to access the driver installer file. 1.
Windows Driver Installation 3. Click Next. 4. Depending on your Windows configuration and user level, a warning may be displayed informing you that the software has not passed Windows Logo testing. 5. Click Continue Anyway. The installation will proceed by installing the necessary files onto your computer. The default directory ocation for the installed files is C:\Zebra\Kiosk\WindowsDriver\KR203. Once the installation has completed, the Completed Window will be displayed.
8 Windows Driver Installation Printer Installation Apply power to the printer and connect the USB cable to the printer and to the host computer. The Windows Found New Hardware Wizard will be displayed. 1. Select “No, not this time” and click Next. A dialog box will appear asking how to install the printer. Select “Install software automatically (Recommended)”. P1028248-001 Rev.
Windows Driver Installation 2. Click Next. Depending on your Windows configuration and user level, a warning may be displayed informing you that the software has not passed Windows Logo testing. 3. Click Continue Anyway. A dialog box will appear asking you to insert the disk containing the Zebra Driver. Click OK. 4. A dialog box will appear prompting you for the location of the Zebra Driver. Click Browse and navigate to C:\Zebra\Kiosk\WindowsDriver\KR203..
10 Windows Driver Installation 5. Click OK.. 6. Click Finish. P1028248-001 Rev.
Windows Driver Installation Uninstall 1. Disconnect the USB cable from the host computer. 2. Double-click on the Zebra Kiosk Printer Driver icon to launch the installer. The Welcome Window is displayed. 3. Select “Uninstall”. 4. Click Next. The Utility will remove the files from the computer. 5. Click Finish. 6. Restart the computer. 8/6/2010 KR203 Software Integrator Guide P1028248-001 Rev.
12 Windows Driver Installation Repair If the driver is not functioning properly, rather than uninstalling and reinstalling the driver it can be repaired. 1. Disconnect the USB cable from the host computer. 2. Double-click on the Zebra Kiosk Printer Driver icon to launch the installer. The Welcome Window is displayed. 3. Select “Repair Application”. 4. Click Next. The Utility will reinstall the necessary files onto the computer. 5. Click Finish. 6. Restart the computer. P1028248-001 Rev.
Windows Driver Installation Disconnecting the Printer The printer may become disconnected from the host computer due to power loss or due to repair procedures. If the host computer is running Windows XP, Windows Vista, Windows 7, Windows Server 2003, or Windows Server 2008, the host computer will automatically recognize the printer upon reconnecting. When the printer is disconnected, the printer icon will show “Offline” then “Offline-Offline”.
14 Windows Driver Properties Properties The Zebra Kiosk Printer Windows driver is based on the Microsoft Unidriver architecture for raster based printers. Zebra provides two OEM libraries (UI and Rendering) to enable specific printer functionality within the driver. In addition to the standard Microsoft driver, Zebra provides a bi-directional interface through a Language Monitor DLL. All of the OEM features will be described below.
Windows Driver Properties Location – Entering a location let’s you know where the printer is should an error need to be corrected. Comment – Any additional information about the printer that may be helpful. Printing Preferences – Simple information about the page layout and paper quality. Advanced settings such as output, graphic options, and document options. Print Test Page – Sends a page to the printer to see if everything is working properly.
16 Windows Driver Properties Sharing The sharing tab enables you to share the printer with other computers. P1028248-001 Rev.
Windows Driver Properties Ports The Ports tab enables you to assign the printer to a specific port on the computer . Additionally, by having the “Enable bidirectional support” box checked, the printer can send messages to the computer. “Enable printer pooling” is useful when multiple printers are connected to the same PC and shared resources are necessary to print many documents, or as a backup. 8/6/2010 KR203 Software Integrator Guide P1028248-001 Rev.
18 Windows Driver Properties Advanced The Advanced Tab enables you to control when receipts are printed. P1028248-001 Rev.
Windows Driver Properties Color Management 8/6/2010 KR203 Software Integrator Guide P1028248-001 Rev.
20 Windows Driver Properties Device Settings The Device Settings Tab is where the main features of the printer are configured. Form To Tray Assignment – Selects the media width and page length. The driver supports page length from 92mm to 600mm with the default set to 400mm. The driver supports page widths of 58, 60, 80, and 82.5mm. The driver incorporates a side margin of 2mm.
Windows Driver Properties size (e.g. if 58mm x 200mm Roll Paper is selected, the print will be 200mm long in Page Mode). When media tracking is set to variable, the driver will shorten the print to only contain the imaged document. The driver will end the print after the last printed element (text, barcode, or graphic) then send a feed, cut, and eject command. The page length may vary from page to page but will always be a minimum of 92mm.
22 Windows Driver Properties Tools The Tools Tab enables access to diagnostic functions and controls. Clear Kiosk Presenter – Ejects any media in the presenter. Send PRN File – Sends a saved PRN file to the printer. Update Firmware – Calls the firmware downloader utility and updates the printer firmware. Set Black Mark Mode – Sets the printer to use black mark media. Set Continuous Mode – Set the printer to print continuous pages. Feed One Receipt – Feeds a single blank receipt.
Windows Driver Properties Printer Controls – Provides additional control for the spooled print job. Delete Print Job on Error: When checked, the driver will delete all print jobs when an error occurs; this includes the current and all following print jobs. When not selected, only the current print job will be deleted; all following print jobs will be retained. Send Printer Parameter: When checked and only send some control commands when unchecked.
24 Windows Driver Properties Update Firmware Check the firmware version installed on the printer by printing a configuration label, the firmware version will be shown. Go to the Zebra Website at www.zebra.com to check the latest version. Follow the procedures on the website and download the firmware package to the computer to which the printer is connected to and that runs the driver. From the Tools tab, click on “Update Firmware”. A dialog box will appear. Select the printer to be updated.
Windows Driver Properties Click “Download Firmware”. Confirm the installation by clicking Yes. The status light on the printer will flash intermittently between green and red indicating that a firmware update is in progress. The printer will reset and the Found New Hardware Wizard will begin configuring the printer with the new firmware. Click “Finish” to continue. 8/6/2010 KR203 Software Integrator Guide P1028248-001 Rev.
26 Windows Driver Properties Printer Information The Printer Information Tab gives detailed information about the service of the printer. The “Enable bidirectional support” box must be checked (see "Ports" on page 17). Cut Odometer – Displays the number of cuts made. Length Odometer – Displays how much media has been fed through the printer. Serial Number – Displays the serial number of the connected printer. Windows Error – Show the windows error code. Printer Status – Displays the state of the printer.
Windows Driver Properties Import/Export Settings The Import/Export Tab enables you to save the current printer configuration for use with other printers. Export – Saves the current printer configuration to a file. Import – Imports a saved printer configuration file. Default – Resets all settings to the default parameters. When Importing or defaulting the properties you should cancel out of the UI to set the newly loaded parameters since an OK will apply the currently set parameters in the Device Settings.
28 Windows Driver Properties About The About Tab shows the current driver version. P1028248-001 Rev.
Windows Driver Setting Black Mark Mode Setting Black Mark Mode The printer is optimized to detect black marks printed with IR sensitive ink and ignore preprint in IR blind ink. For 80 and 82.
30 Windows Driver Setting Black Mark Mode P1028248-001 Rev.
3 Troubleshooting Status Light Descriptions Application LED States Immediately after power is applied to the printer, a brief self test is performed and the status light will report the following conditions: Table 3-1 • Application LED States Rev. A Solid Green 0 - OK This code is reported when no other codes are active. It indicates the printer is functioning normally. One Red Flash 1 - Paper Jam in Presenter This code indicates that media is stuck in the presenter.
32 Troubleshooting Status Light Descriptions Table 3-1 • Application LED States Rev. A Three Red Flashes 3 - Out of Paper This code indicates that the selected EOP sensor has detected no media present. This value is signaled wither when the mark engine has detected a mark larger than "TOF marker length” plus 5mm, or when the A/D reading of the EOP sensor drops below the “End of paper threshold”. This error is cleared after successful media load (either via calibration of via regular media load).
Troubleshooting Print Quality Problems Application User Interface With the printer power on, press and hold the feed button. Continue holding the feed button until the status indicator flash sequence occurs. The next flash sequence occurs after completion of the previous flash sequence. The flash sequences perform the following functions: Table 3-2 • Application User Interface Status Flash Sequence Action One Flash, then Solid Green Appears for one second. This will print an internal self-test page.
34 Troubleshooting Print Quality Problems The printed image does not look right. • The printhead is dirty. Clean the printhead. Refer to the Service Manual (P1028249) for instructions. • The printhead has worn out. The printhead is a consumable item and will wear out due to friction between the media and printhead. Using unapproved media may shorten life or damage your printhead. Replace the printhead. Refer to the Service Manual (P1028249) for instructions. • Adjust the print darkness and/or print speed.
Troubleshooting Media Sensing Problems Media Sensing Problems The KR403 printer default media mode is Continuous. The printer will remain in this mode until it is changed by the Windows Driver. The KR403 printer has automatic media calibration capability for black mark media. Once the printer is printing or feeding media, the printer continually checks and adjusts the media sensing to accommodate for minor changes in media parameters from page to page on a roll, and from roll to roll of media.
36 Troubleshooting Other Problems • There is a jam under the printhead. Refer to the Service Manual (P1028249) for instructions. • The large media roll may be over torquing the feed motor. Install the large media roll adapter. Refer to the Hardware Integrator Guide (P1016701) for instructions. The printer will not eject the media. • The presenter rollers are dirty or damaged. • The presenter rollers are dirty. Refer to the Service Manual (P1028249) for instructions.
Troubleshooting Other Problems • The cutter motor may need to be replaced. Refer to the Service Manual (P1028249) for instructions. • The cutter drive gear, drive pin, or cutter actuator may be damaged or worn. Refer to the Service Manual (P1028249) for instructions. • Check for the latest firmware and driver version. There are no lights on the printer. • Make sure there is power applied to the printer. • The control panel may be dirty or damaged. Refer to the Service Manual (P1028249) for instructions.
38 Troubleshooting Resetting the Factory Default Values Resetting the Factory Default Values Sometimes, resetting the printer to the factory defaults may solve some problems. Refer to the four-flash sequence of "Application User Interface" on page 33. Contact Technical Support Technical Support via the Internet is available 24 hours per day, 365 days per year. www.zebra.com For questions on the operation of Zebra equipment and software, please call your distributor. For additional assistance, contact us.
Appendix A Windows Compatible Status These statuses will also be stored in the printer ERROR key in the registry and can be extracted with GetPrinterData. Statuses Defined in winspool.
A-2 Appendix A Windows Compatible Status Table A-1 • Windows Status Compares to Zebra Status PRINTER_STATUS_NOT_AVAILABLE Wrong firmware (ESC ENQ 1 = NAK 14), check ExtendedError PRINTER_STATUS_NOT_AVAILABLE Retract occurred (ESC ENQ 1 = NAK 16), check ExtendedError PRINTER_STATUS_NOT_AVAILABLE Paused (ESC ENQ 1 = NAK 17), check ExtendedError PRINTER_STATUS_TONER_LOW Paper near end (ESC ENQ 6) PRINTER_STATUS_OUTPUT_BIN_FULL Paper in presenter (ESC ENQ 6) Table A-2 • Status definition in Winspool
Appendix A Windows Compatible Status Windows Incompatible Status If a printer status doesn’t have a corresponding Windows status the Error key will have PRINTER_STATUS_NOT_AVAILABLE set and you need to evaluate the ExtendedError key. Statuses that have a representation within the Windows status may also have an ESC ENQ 1 NAK value (see Table A-1) and will be stored in the printer ExtendedError key in the registry and can be extracted with GetPrinterData using the ExtendedError key.
A-4 Appendix A Windows Compatible Status P1028248-001 Rev.
Appendix B Programming Example Background In order to incorporate the way status monitoring works for the KR203 printer setup, it is important to understand what happens in a kiosk when you print, and when status monitoring should take place. Status monitoring can be handled in two ways: • Monitoring in the printing application. • Monitoring in a separate application.
B-2 Appendix B Programming Example • Monitoring while printing Status monitoring has been implemented in the internal printing structure of the language montor. When a document is opened, printed, and closed, the language monotr will check the printer status before and after printing and will also react to write errors if any occur. It will then set the printer status and raise the error event.
Appendix B Implementation in Calling Application Implementation in Calling Application 1. Open the Printer. The first step of the implementation is to open the printer required to monitor and get the Error event and Status even name. bRet = OpenPrinter(m_csPrinter.
B-4 Appendix B Implementation in Monitor Thread Implementation in Monitor Thread 1. Fill Event Arrays In the monitoring thread, create and fill an array of handles with the error and status event handle. myHandle[0] = pInfo->hError; myHandle[1] = pInfo->hStatus; 2. Start the Waiting Loop Start the waiting loop.
Appendix B Implementation in Monitor Thread while(pInfo->m_hStatusEventKillThread) { if ((dwRet = WaitForMultipleObjects(2, myHandle, FALSE, pInfo->dSleepTime))!=WAIT_FAILED) { if (dwRet==WAIT_OBJECT_0 || dwRet==WAIT_OBJECT_0+1) { if ((dwRet = GetPrinterData(pInfo->hPrinter, L"Error", &dType, (LPBYTE)&dwResult, sizeof(dwResult), &dNeeded))!=ERROR_SUCCESS) { swprintf_s( str, 50, L"### [Status Thread error %d] read [%08X]\n", dwRet, dwResult); } else swprintf_s( str, 50, L"### [Status Thread] read [%08X]\n",
B-6 Appendix B Implementation in Monitor Thread SendMessage(hWnd, WM_SETTEXT, 0, (LPARAM)(L"PRINTER_STATUS_IO_ACTIVE")); if (dwResult & PRINTER_STATUS_BUSY) SendMessage(hWnd, WM_SETTEXT, 0, (LPARAM)(L"PRINTER_STATUS_BUSY")); if (dwResult & PRINTER_STATUS_PRINTING) SendMessage(hWnd, WM_SETTEXT, 0, (LPARAM)(L"PRINTER_STATUS_PRINTING")); if (dwResult & PRINTER_STATUS_OUTPUT_BIN_FULL) SendMessage(hWnd, WM_SETTEXT, 0, (LPARAM)(L"PRINTER_STATUS_OUTPUT_BIN_FULL")); if (dwResult & PRINTER_STATUS_PROCESSING) SendM
Appendix B Implementation in Monitor Thread SendMessage(hWnd, WM_SETTEXT, 0, (LPARAM)(L"Timeout, no status happened")); } else { dwRet = GetLastError(); swprintf_s( str, 50, L"### Wait function failed! [%d]\n", dwRet); OutputDebugString(str); } } SendMessage(hWnd, WM_SETTEXT, 0, (LPARAM)(L"Leaving Status Thread")); AfxEndThread( 1 ); return 1; } When an event occurs, the status with GetPrinterData using the “Error” key will need to be obtained, and the result decoded according to the sample or an equivalen
B-8 Appendix B WMI Script to get Basic Status WMI Script to get Basic Status ' VBScript source code ttpname="" strComputer = "." Set objWMIService = GetObject("winmgmts:" _ & "{impersonationLevel=impersonate}!\\" & strComputer & "\root\cimv2") Set wbemObjectSet = objWMIService.ExecQuery("SELECT * FROM Win32_Printer") For Each wbemObject In wbemObjectSet if wbemObject.Default = TRUE then ttpname = wbemObject.Caption Wscript.Echo "Printer " & ttpname Select Case wbemObject.
Appendix B WMI Script to get Basic Status Wscript.Echo "DetectedErrorState: " & wbemObject.DetectedErrorState & " No Error" case 3 Wscript.Echo "DetectedErrorState: " & wbemObject.DetectedErrorState & " Low Paper" case 4 Wscript.Echo "DetectedErrorState: " & wbemObject.DetectedErrorState & " No Paper" case 5 Wscript.Echo "DetectedErrorState: " & wbemObject.DetectedErrorState & " Low Toner" case 6 Wscript.Echo "DetectedErrorState: " & wbemObject.DetectedErrorState & " No Toner" case 7 Wscript.
B-10 Appendix B WMI Script to get Basic Status case 4 Wscript.Echo "ExtendedDetectedErrorState: " & wbemObject.ExtendedDetectedErrorState & " No Paper" case 5 Wscript.Echo "ExtendedDetectedErrorState: " & wbemObject.ExtendedDetectedErrorState & " Low Toner" case 6 Wscript.Echo "ExtendedDetectedErrorState: " & wbemObject.ExtendedDetectedErrorState & " No Toner" case 7 Wscript.Echo "ExtendedDetectedErrorState: " & wbemObject.ExtendedDetectedErrorState & " Door Open" case 8 Wscript.
Appendix B WMI Script to get Basic Status Next Wscript.Echo 8/6/2010 "Printer " & ttpname KR203 Software Integrator Guide P1028248-001 Rev.
B-12 Appendix B WMI Script to get Basic Status P1028248-001 Rev.
Appendix C Setup Printer Forms in Windows XP and Vista Windows XP and Vista allows you to control global settings for print servers by using the Print Server Properties dialog box. You can access this dialog box by doing the following: 1. Double-click on the printer's icon in the Control Panel or select Settings in the Start menu and then choose the Printers option. 2. In the Printers window, select Server Properties from the File menu. 3.
C-2 Appendix C Setup Printer Forms in Windows XP and Vista Viewing and Creating Printer Forms Forms are used by the print server to define the standard sizes for paper, envelopes, and transparencies. To view the current settings for a printer form, follow these steps: 1. Open the Print Server Properties dialog box and then click on the Forms tab as shown above. 2. Use the Forms On list box to select the form you want to view. The form settings are shown in the Measurements area.
Appendix C Setup Printer Forms in Windows 7 Setup Printer Forms in Windows 7 You can use Print Management to manage printer forms. To open Print Management, click Start, point to Administrative Tools, and then click Print Management. You must have Administrative permissions to perform this task. To manage forms: 1. Open Print Management. 8/6/2010 KR203 Software Integrator Guide P1028248-001 Rev.
C-4 Appendix C Setup Printer Forms in Windows 7 2. In the left pane, click Print Servers, click the applicable print server, right-click Forms, and then click Manage Forms. 3. In the Printer Server Properties dialog box, do the following: P1028248-001 Rev.
Appendix C Setup Printer Forms in Windows 7 4. To create a new form, select an existing form, select the Create a new form check box, change the printer measurement units, paper size, and printer area margins as needed, click Save Form, and then click OK. 5. To delete a form, select the form, click Delete, and then click OK. 8/6/2010 KR203 Software Integrator Guide P1028248-001 Rev.
C-6 Appendix C Setup Printer Forms in Windows 7 P1028248-001 Rev.
