Link-OS™ Virtual Device-Mi User Guide P1076806-001 Rev.
© 2015 ZIH Corp. The copyrights in this manual and the software and/or firmware in the printer described therein are owned by ZIH Corp. and Zebra’s licensors. 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.
End User License Agreement Please read the terms of this “End User License Agreement” (the “Agreement”) carefully. The Agreement is a legal agreement between you (either an individual or a single entity) and Zebra Technologies International, LLC (“Zebra”) for the Zebra computer software and/or firmware accompanying this End User License Agreement, and any associated media, printed materials and any “online” or electronic documentation (collectively, “Software”).
7. Intellectual Property and Feedback. All title, copyrights and other intellectual property rights in and to the Software (including but not limited to copyrights, patents, trade secrets and trademarks) are owned by Zebra or its suppliers and licensors. You must maintain all copyright notices on all copies of the Software. All rights not expressly granted are reserved by Zebra.
12. Disclaimer. ZEBRA SUPPLIES THE SOFTWARE AS IS AND WITH ALL FAULTS AND DOES NOT MAKE ANY WARRANTIES WHATSOEVER, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES CONCERNING THE SOFTWARE OR ANY APPLICATION, OPERATION OR USE THEREOF, THE OUTPUT OR THE DATA GENERATED BY THE OPERATION OR USE THEREOF, OR ANY SUPPORT SERVICES RENDERED WITH RESPECT THERETO.
14. Zebra Suppliers and Licensors.
Contents About This Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Who Should Use This Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 How This Document Is Organized . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents apl.framework_version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 Supported Fonts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 Download the ZDownloader Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
About This Document This section provides you with document structure and organization, and additional reference documents. Contents Who Should Use This Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 How This Document Is Organized . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
About This Document Who Should Use This Document Who Should Use This Document This manual describes the Virtual Device-Mi language for Zebra mobile and tabletop printers and should be used by any person who needs to support that language on one of the following Zebra printers: Printer Firmware QLn™ Series V68.19.6Z or later ZT200™ Series V72.19.6Z or later ZT400™ Series V75.19.7Z or later ZD500™ Series V74.19.6Z or later iMZ™ Series V73.19.
Introduction This section describes the features and functions of a Zebra printer that is running the Virtual Device-Mi application. The Virtual Device-Mi application enables Zebra mobile and tabletop printers to work with many host systems that are using MICROCOM CORPORATION™ printers. In most cases, no changes will be required to the host application. This feature can help customers to make a smooth transition to Zebra printers and save them the time and expense of having to rewrite their host software.
Introduction Virtual Device-Mi Features Virtual Device-Mi Features The Virtual Device-Mi application: • Uses existing features of Zebra printers, when available. • Offers fonts similar to the original device. These fonts will use 120 KB or more of memory space. • Supports the Bluetooth®, RS-232, Ethernet, WLAN, and USB interfaces. • Offers many outline fonts, barcodes, and specific commands and features of target printer models (see Supported Fonts on page 43).
Install, Register, and Enable Virtual Device-Mi This section provides you with instructions on how to install and enable the Virtual Device-Mi application on one or more Zebra printers. Contents Acquiring the Virtual Device Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Downloading the Virtual Device-Mi Application Using ZDownloader . . . . . . . . . . . . . . . . Adding Printers to the ZDownloader List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Getting Started Acquiring the Virtual Device Application Acquiring the Virtual Device Application To get the Virtual Device app, perform the following from your computer: 1. Open a web browser and navigate to http://www.zebra.com/us/en/products- services/software/link-os/virtual-devices.html. 2. Locate your printer type in the list of printers, and then click “Download Now.” 3. Fill out the information on the Virtual Device Download Request form. 4. Click “Submit.” 5.
Getting Started Downloading the Virtual Device-Mi Application Using ZDownloader Downloading the Virtual Device-Mi Application Using ZDownloader Note • Zebra recommends that you use the Zebra Downloader to download the Virtual Device-Mi app. For instructions on how to download the Zebra Downloader, see Download the ZDownloader Application on page 47. The ZDownloader application can update Virtual Device-Mi files in Zebra printers connected by RS-232, Parallel, USB, and IP Ethernet networks.
Getting Started Downloading the Virtual Device-Mi Application Using ZDownloader Auto-Detect Printers Use Auto-Detect for USB or IP Ethernet interfaces. Note • Ethernet connected printers are detected by the application broadcasting a UDP packet out onto the network. UDP port number 4201 is used for the discovery process. Some networks filter out UDP packets. This means that the ZDownloader program may not be able to detect all of the printers on your network.
Getting Started Downloading the Virtual Device-Mi Application Using ZDownloader To Auto-Detect printers connected via the USB or IP Ethernet interfaces, perform the following steps: 1. In the ZDownloader toolbar, click the “Auto-Detect” button . OR Right-click in the ZDownloader window and select “Auto-Detect Printers.” The printers detected are added to the printer list.
Getting Started Downloading the Virtual Device-Mi Application Using ZDownloader Adding an RS-232 Printer If you will not be adding a serial printer, skip to step 8 to install a parallel printer or step 11 to install a network printer. 3. Select the serial port to which the printer is connected. 4. Click Port Settings. The following window appears. 5. Adjust the settings as necessary. The printer’s serial port settings must match the computer’s serial port settings.
Getting Started Downloading the Virtual Device-Mi Application Using ZDownloader 7. Click OK to add the printer. Adding a Parallel Printer If you will not be adding a parallel printer, skip to step 11 to install a network printer. 8. Select the Parallel Communication Type. The available parallel ports will be shown in the Port drop-down box. 9. Select the port to which the printer is connected. No additional configuration is necessary. 10. Click OK to add the printer. Adding a Network Printer 11.
Getting Started Downloading the Virtual Device-Mi Application Using ZDownloader 14. Click OK to save the network settings. 15. Click OK to add the printer. Modifying Printers in the List To change printer settings for a printer in the list, perform the following steps: 1. Select the printer to modify. 2. In the toolbar, click the “Modify Printer” button . OR Right-click on the printer and select “Modify Printer…”. The printer settings for the selected printer are displayed. 3.
Getting Started Downloading the Virtual Device-Mi Application Using ZDownloader Deleting Printers from the List To delete printers from the list, perform the following steps: 1. Select one or more printers to delete. 2. Click the “Delete Printer(s)” toolbar button . OR Right-click on one of the selected printers and select “Delete Printer(s)”. The printer is removed from the list.
Getting Started Downloading the Virtual Device-Mi Application Using ZDownloader Downloading the Virtual Device App to Selected Printers In order to download the Virtual Device-Mi app to your printer(s), you must select the file to send to each printer. Figure 2 • ZDownloader Screen with Multiple Printers Added To download the Virtual Device app file to one or more printers, perform the following steps: 1. Select the printers to which you want to download the Virtual Device-Mi app file.
Getting Started Downloading the Virtual Device-Mi Application Using ZDownloader 4. Click Open. The file that you selected appears under Download File for the selected printers. Printers that are present in the list, but do not have a file selected will be ignored when Downloading starts. 5. Click the “Download to All Printers” toolbar button . OR Select the printer(s) of interest and select “Printer > Download To Selected.” 6. Click the “Download All” toolbar button .
Getting Started Downloading the Virtual Device-Mi Application Using ZDownloader Canceling a Download in Progress The “Cancel Download” toolbar button and the “Printer > Cancel Download” menu options become active when the files are downloading. To cancel downloading to ALL printers in the list, perform the following step: 1. Click the “Cancel Download” toolbar button . OR Right-click in the ZDownloader window and select “Cancel Download.
Getting Started Registering the Virtual Device Registering the Virtual Device ZDownloader maintains a log file of all items downloaded to a Zebra printer along with the printer serial number. You can register your Virtual Device installation with Zebra Repair and Tech Support to ensure that a printer sent in for repair is returned with the Virtual Device installed, and when engaging Zebra Tech Support, they will have records of the item being loaded.
Getting Started Enabling the Virtual Device Enabling the Virtual Device You can enable Virtual Device-Mi by sending a Set/Get/Do (SGD) command to the printer or by selecting the option through the printer’s menus on models that have a control panel display. Note • ZPL and CPCL may not function normally when a Virtual Device is enabled. Using an SGD Command To enable Virtual Device-Mi on your printer, send the following command: ! U1 setvar "apl.
Getting Started Enabling the Virtual Device QLn420 Printers 1. From the printer’s idle display screen, press the LEFT SOFT KEY to select the Home icon. PRINTER READY VXXXXXXX The printer displays the Home Menu. SETTINGS 2. Use the ARROWS to navigate to the LANGUAGE menu.
Getting Started Enabling the Virtual Device 3. Press the OK button. The printer displays the LANGUAGE selection screen. LANGUAGE ▼ ENGLISH ▲ 4. Use the LEFT or RIGHT ARROW to navigate to the VIRTUAL DEVICE selection screen.
Getting Started Enabling the Virtual Device 5. Use the UP or DOWN ARROW to scroll to the APL-Mi option. VIRTUAL DEVICE ▼ APL-MI ▲ USE 6. Press the RIGHT SOFT KEY to select USE. The printer restarts and uses the Virtual Device that you selected.
Getting Started Enabling the Virtual Device QLn320 and QLn220 Printers 1. From the printer’s idle display screen, press the LEFT SOFT KEY to select the Home icon. Zebra QLn320 FW ver: XXXXXXXXXX Baud Rate: 115200 Battery ok IP Addr: 10.14.205.138 Menu The printer displays the Home Menu. Communication Back 2. Use the ARROWS to navigate to the SETTINGS menu.
Getting Started Enabling the Virtual Device 3. Press the OK button. The printer displays the VIRTUAL DEVICE selection screen. Virtual Dev: none Menu ▲ Use ▼ Back 4. Press the RIGHT ARROW to highlight the up arrow on the display. 5. With the up arrow highlighted, press the OK button until you scroll to the apl-mi option.
Getting Started Enabling the Virtual Device 6. Press the LEFT ARROW to highlight apl-mi. 7. Press OK to select USE. The printer restarts and uses the Virtual Device that you selected.
Getting Started Enabling the Virtual Device ZT230, ZT400-Series, and ZD500-Series Printers Note • The ZT230 control panel is shown in this procedure. The control panel for the other printers is similar. 1. From the printer’s idle display screen, press the LEFT SELECT KEY to select the Home icon. PRINTER READY VXXXXXXX The printer displays the Home Menu.
Getting Started Enabling the Virtual Device 2. Use the ARROWS to navigate to the LANGUAGE menu. HOME MENU SETTINGS 3. Press the OK button. The printer displays the LANGUAGE selection screen.
Getting Started Enabling the Virtual Device 4. Use the LEFT or RIGHT ARROW to navigate to the VIRTUAL DEVICE selection screen. ▼ VIRTUAL DEVICE NONE ▲ 5. Use the UP or DOWN ARROW to scroll to the APL-Mi option.
Getting Started Enabling the Virtual Device 6. Press the RIGHT SOFT KEY or OK to select USE. ▼ VIRTUAL DEVICE APL-MI ▲ USE The printer restarts and uses the Virtual Device that you selected.
Commands This section provides a listing of commands for use on your Zebra printer with the Virtual Device-Mi app. Contents Table of Supported Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 Set/Get/Do (SGD) Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Commands Table of Supported Commands Table of Supported Commands For a complete list of commands (including those that are not supported and not listed here), refer to the documentation that came with your printer.
Commands Table of Supported Commands Supported (✓) Syntax Command Function TCI Text conversion identifier CGN Character generator number FO Field orientation ✓ FJ Field justification ✓ only 0 (left), 1 (right), 4 (center) CMX Character multiplier X direction ✓ CMY Character multiplier Y direction ✓ CS Character spacing — TSP Text starting position — AN Attribute number — 01/26/2015 Virtual Device-Mi User Guide ✓ only 1, 6, 8, 16 ✓ only 1, 2, 3, 4, 5, 6, 7, 8 P1076806-001 39
Commands Set/Get/Do (SGD) Commands Set/Get/Do (SGD) Commands The following SGD commands were added for use with your Virtual Device app. For more detailed information on SGD commands, see the Programming Guide for ZPL II®, ZBI 2, Set/Get/Do, Mirror, and WML (formerly the ZPL II Programming Guide). apl.enable Description This command enables or disables a Virtual Device app. Note • • • ZPL and CPCL may not function normally when a Virtual Device app is enabled.
Commands Set/Get/Do (SGD) Commands apl.framework_version Description This command returns the level of support for Virtual Devices in the printer operating system. Type getvar Commands Details getvar Format: ! U1 getvar "apl.
Commands Set/Get/Do (SGD) Commands Notes • ___________________________________________________________________ __________________________________________________________________________ __________________________________________________________________________ __________________________________________________________________________ __________________________________________________________________________ __________________________________________________________________________ ________
Supported Fonts This section provides you with examples of the fonts available on the Zebra printers with Virtual Device-Mi.
Supported Fonts Table 1 • Supported Fonts (Continued) P1076806-001 Virtual Device-Mi User Guide 01/26/2015
Supported Fonts Table 1 • Supported Fonts (Continued) 01/26/2015 Virtual Device-Mi User Guide P1076806-001 45
Supported Fonts Table 1 • Supported Fonts (Continued) P1076806-001 Virtual Device-Mi User Guide 01/26/2015
Download the ZDownloader Application Zebra recommends that you use the ZDownloader application to download a Virtual Device app to your printers. This section provides you with the instructions for downloading and installing this application. To install the ZDownloader appllication, perform the following from your computer: 1. Open a web browser and navigate to http://www.zebra.com/us/en/products- services/services/development-services/custom-app.html. Click the link for ZDownloader.
Download the ZDownloader Application 3. If you are prompted to allow the application to make changes to your computer, click Yes. The program installs on your computer. When installation is complete, the Firmware Downloader and ZBI Key Manager installation wizard appears: 4. Click Next. The End User Licence Agreement appears. 5. Read the terms of the agreement. 6. Click the box to accept the terms. 7. Click Next. The installation wizard displays information about the installation.
Download the ZDownloader Application 8. Read the installation information. 9. Click Next. The installation wizard displays information about the installation.
Download the ZDownloader Application 10. Click Next. The installation wizard installs the application. When installation is complete, the installation wizard prompts you to restart your computer. 11. To finish and restart your computer, click Finish.
Index A F application installation acquiring the app, 14 canceling a download in progress, 24 downloading the app to printers, 22 auto-detect printers, 16 features, 12 fonts, 43 I IP Ethernet printers auto-detect, 16 manually add, 17 C commands and command parameters, 38 M D disabling the Virtual Device by apl.
Index V version level of support for Virtual Devices, 41 of Virtual Device, 40 Virtual Device version, 40 W wired print server auto detect, 16 manually add, 17 P1076806-001 wireless print server auto detect, 16 manually add, 17 Z ZDownloader adding printers, 15 allow simultaneous downloads, 24 canceling a download in progress, 24 deleting printers, 21 downloading the Virtual Device app to printers, 22 downloading the ZDownloader application, 47 modifying printer settings, 20 Virtual Device-Mi User
Zebra Technologies Corporation Zebra Technologies Corporation 475 Half Day Road, Suite 500 Lincolnshire, IL 60069 USA T: +1 847 634 6700 Toll-free +1 866 230 9494 F: +1 847 913 8766 Zebra Technologies Europe Limited Dukes Meadow Millboard Road Bourne End Buckinghamshire, SL8 5XF, UK T: +44 (0)1628 556000 F: +44 (0)1628 556001 Zebra Technologies Asia Pacific, LLC 120 Robinson Road #06-01 Parakou Building Singapore 068913 T: +65 6858 0722 F: +65 6885 0838 http://www.zebra.com © 2015 ZIH Corp.