Zebra ZBI-DEVELOPER USER MANUAL

ZBI-Developer™

User Guide

48789L-002

therein are owned by ZIH Corp. Unauthorized reproduction of this manual or the software and/or firmware in the label 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.

, ZPL II®, and ZebraLink™ programs; Element Energy Equalizer® Circuit; E3®; and

ZebraLink and all product names and numbers are trademarks, and Zebra, the Zebra logo, ZPL, ZPL II, Element Energy Equalizer Circuit, and E

All other brand names, product names, or trademarks belong to their respective holders. For additional trademark information, please see “Trademarks” on the product CD.

Proprietary Statement This manual contains proprietary information of Zebra Technologies Corporation and its

subsidiaries (“Zebra Technologies”). It is intended solely for the information and use of parties operating and maintaining the equipment described herein. Such proprietary information may not be used, reproduced, or disclosed to any other parties for any other purpose without the express, written permission of Zebra Technologies.

Product Improvements Continuous improvement of products is a policy of Zebra Technologies. All

specifications and designs are subject to change without notice.

Liability Disclaimer Zebra Technologies takes steps to ensure that its published Engineering specifications and

manuals are correct; however, errors do occur. Zebra Technologies reserves the right to correct any such errors and disclaims liability resulting therefrom.

Limitation of Liability In no event shall Zebra Technologies or anyone else involved in the creation, production,

or delivery of the accompanying product (including hardware and software) be liable for any damages whatsoever (including, without limitation, consequential damages including loss of business profits, business interruption, or loss of business information) arising out of the use of, the results of use of, or inability to use such product, even if Zebra Technologies has been advised of the possibility of such damages. Some jurisdictions do not allow the exclusion or limitation of incidental or consequential damages, so the above limitation or exclusion may not apply to you.

Part Number: 48789L-002

About This Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Who Should Use This Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

How This Document Is Organized . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Contacts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Document Conventions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Related Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11

ZBI-Developer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Introduction - Welcome to ZBI-Developer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Printers, ZBI Keys & ZBI Versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Supported Print Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Starting ZBI-Developer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

The Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Menu and Toolbars. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Edit Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Run Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Window Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

ZBI Perspective. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Navigator View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Printer View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Create a Virtual Printer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Edit a Virtual Printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Using Virtual Printers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Problems View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

5/14/09 ZBI-Developer User Guide 48789L-002

Contents

Debug Perspective . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Debug View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Printer Status View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Variable View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Breakpoints View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Help Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

View ASCII Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

About ZBI-Developer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

Configuration of ZBI-Developer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Changing the Workspace Location. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Setting Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

Changing the Screen Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

ZBI-Developer Tutorial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Perspectives. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Project Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Starting the Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Starting a New Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Starting a New ZBI Program. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

Saving a New ZBI Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

Writing a New ZBI Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

ZBI Command Syntax Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

The Problems View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

Setting Breakpoints. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

Discovering Printers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

Setting Up Searches. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

Using a Printer via the Serial Port. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

Using a Printer via the Parallel Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

Using Virtual Printers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

Creating a Debug Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

Debug a Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

Changing the Screen Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

Run a Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

Step Over a Breakpoint. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

Terminating a Running Program. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

Creating the Autoexec.zpl file. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

Sending Files to Printers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

Using CSV/TXT Files with Virtual Printers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

Import ZBI Files From a Printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

Compare or Replace Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

48789L-002 ZBI-Developer User Guide 5/14/09

Contents

Encryption of ZBI Programs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

The Default Encryption Key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

Encrypt a ZBI Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

Distributing Encrypted Programs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

Generate a New Key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

Key Storage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

ZBI File Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

ZBI Technical Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

Online Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

Contact Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

5/14/09 ZBI-Developer User Guide 48789L-002

Contents

Notes • ___________________________________________________________________

__________________________________________________________________________

48789L-002 ZBI-Developer User Guide 5/14/09

About This Document

This section provides you with contact information, documen t struc ture and organization, and additional reference documents.

Contents

Who Should Use This Document. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

How This Document Is Organized . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Contacts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Document Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Related Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

5/14/09 ZBI-Developer User Guide 48789L-002

About This Document

Who Should Use This Document

This User Guide helps you quickly develop, test, and distribute ZBI programs using ZBI-Developer™.

How This Document Is Organized

The User Guide is set up as follows:

Section Description

Introduction - Welcome to ZBIDeveloper

Installation The Interface Configuration of ZBI-Developer

ZBI-Developer Tutorial

Encryption of ZBI Programs

An introduction to ZBI-Developer

How to install the program Describes the ZBI-Developer interface How to set up and customize software to your

preferences How to create, test, and distribute a new ZBI

programs using the ZBI-Developer environment How to optionally encrypt programs before

distributing them How to contact technical support

48789L-002 ZBI-Developer User Guide 5/14/09

Contacts

About This Document

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.com/techrequest

Contacts

Which Department

Do You Need?

Regional Headquarters

Technical Support

For questions on the operation of Zebra equipment and software, please call your distributor. For additional assistance, contact us.

Please have your model and serial numbers available.

Repair Service Department

For back-to-base service and repair.

Technical Tr aining Department

For Zebra product training courses.

Inquiry Department

For product literature and distributor and dealer information.

Customer Service Department (US) Internal Sales Department (UK)

For printers, parts, media, and ribbon, please call your distributor or contact us.

Key:

T: Telephone F: Facsimile E: E-mail

The Americas

Zebra Technologies In ternational, LLC 333 Corporate W oods Parkway Vernon Hills, IL 60061-3109 U.S.A.

T: +1 847 793 2600 Toll-free +1 800 423 0422 F: +1 847 913 8766

T: +1 877 ASK ZEBRA (275 9327) F: +1 847 913 2578

Hardware: ts1@zebra.com Software: ts3@zebra.com

Kiosk printers:

T: +1 866 322 5202 E: kiosksupport@zebra.com

T: +1 877 ASK ZEBRA (275 9327) F: +1 847 821 1797

E: repair@zebra.com To request a repair in the U.S.,

go to www.zebra.com/repair T: +1 847 793 6868

T: +1 847 793 6864 F: +1 847 913 2578

E: ttamerica@zebra.com

T: +1 877 ASK ZEBRA (275 9327) E: inquiry4@zebra.com

T: +1 877 ASK ZEBRA (275 9327) E: clientcare@zebra.com

Europe, Africa,

Middle East, India

Zebra Technologies Europe Limited Dukes Meadow Millboard Road Bourne End Buckinghamshire, SL8 5XF United Kingdom

T: +44 (0) 1628 556000 F: +44 (0) 1628 556001

T: +44 (0) 1628 556039 F: +44 (0) 1628 556003

E: Tseurope@zebra.com

T: +44 (0) 1772 693069 F: +44 (0) 1772 693046

New requests: ukrma@zebra.com Status updates:

repairupdate@zebra.com

T: +44 (0) 1628 556000 F: +44 (0) 1628 556001

E: Eurtraining@zebra.com

T: +44 (0) 1628 556037 F: +44 (0) 1628 556005

E: mseurope@zebra.com

T: +44 (0) 1628 556032 F: +44 (0) 1628 556001

E: cseurope@zebra.com

Asia Pacific

Zebra Technologies Asia Pacific Pte. Ltd. 120 Robinson Road #06-01 Parakou Building Singapore 068913

T: + 65 6858 0722 F: +65 6885 0838

T: +65 6858 0722 F: +65 6885 0838

E: China: tschina@zebra.com

All other areas:

tsasiapacific@zebra.com

T: +65 6858 0722 F: +65 6885 0838

E: China: tschina@zebra.com

All other areas:

tsasiapacific@zebra.com

T: + 65 6858 0722 F: +65 6885 0838

E: China: tschina@zebra.com

All other areas:

tsasiapacific@zebra.com

E: China: GCmarketing@zebra.com

All other areas:

AP ACChannelmarketing@zebra.com

T: +65 6858 0722 F: +65 6885 0836

E: China: order-csr@zebra.com

All other areas:

csasiapacific@zebra.com

5/14/09 ZBI-Developer User Guide 48789L-002

About This Document

Document Conventions

The following conventions are used throughout this document to convey certain information.

Alternate Color (online only) Cross-references contain hot links to other sections in this guide. If you are viewing this guide online in .p df format, you can click the cross-reference (blue text) to jump directly to its location.

Command Line Examples Command line examples appear in Courier New font. For example, type

Files and Directories File names and directories appear in Courier New font. For example, the

Notes and Examples

Note • Indicates neutral or positive information that emphasizes or supplements important

points of the main text.

Example • Provides an example, often a scenario, to better clarify a section of text.

ZTools to get to the Post-Install scripts in the bin directory.

Zebra<version number>.tar file and the /root directory.

48789L-002 ZBI-Developer User Guide 5/14/09

ZBI-Developer

Introduction - Welcome to ZBI-Developer

ZBI-Developer is an Integrated Development Environment (IDE), designed to assist in the creation, testing and distribution of programs written for use in the Zebra Basic Interpreter™ (ZBI™).

ZBI-Developer offers several ease-of-use features:

• Project File Control – Keeps related files in a single Project folder

• Pop-up Help – displays ZBI command syntax and examples

• Virtual Printers – allows ZBI programs to be run on the PC, with no need for a printer

• Multiple Perspectives – displays different display modes for the software:

• ZBI Perspective – used for writing ZBI programs

• Debug Perspective – used for testing and checking programs

• Multiple Views – displays different information screens:

• Navigator View – used to manage Projects and files in projects

• Printer View – used to manage physical and virtual printers

• Debug View – used to display the name of the program being tested

• Breakpoints View – used to view the list of breakpoints and jump to each point

• Variable View – used to view the current value of variables in the program

• Problems View – displays Warnings and Errors detected in the ZBI program

• Ports View – displays data as it flows through ports used in the program

• Program Distribution – programs can be easily sent to a prin ter

• Program Encryption – programs can be encrypted in order to protect proprietary data

• File Drag and Drop – files can be dragged into a project from the Windows® Explorer environment

• File Import – files can be imported from printers into Projects in ZBI-Developer

• File Compare – files can be compared to earlier versions of the same file or to other files

5/14/09 ZBI-Developer User Guide 48789L-002

ZBI-Developer

Introduction - Welcome to ZBI-Developer

System Requirements

These are the minimum requirements needed to run ZBI-Developer™

• Pentium®-based computer with at least 64 MB of RAM

• One of the 32-bit Windows® operating system:

• Windows 20 00 ®

•Windows XP®

•Windows Vista®

• Windows Server 2003®

• Hard disk with 80 MB of free disk space

• Administrator rights to the local computer during installation

Printers, ZBI Keys & ZBI Versions

Information about ZBI 1.x and ZBI 2.x:

ZBI versions 1.0 through 1.5:

ZBI 1.x was available on printers with X.10 or higher firmware (such as V48.10.x). To determine if the printer supports ZBI version 1, check the firmware version loaded on the printer. This can be determined by the absence of a “Z” in the firmware version number (for example, firmware V60.13.0.12 supports ZBI version 1, while V60.13.0.12Z does not). The following printers support the ZBI 1.x firmware:

• LP/TLP 284x-Z and 384x-Z

• S300/S400/S500/S600

• Z4000/Z6000

•Z4M/Z6M

Z4Mplus/Z6Mplus

•

• 105SL

• PAX 3

• XiII

• XiIII

ZBI-Developer can be used to create programs for use on printers that support ZBI version

1.x., however, the features that are only available in ZBI v2.x cannot be used with printers running ZBI v1.x. For example, “on-printer” debugging advanced file encryption and commands added in ZBI 2 are not supported in printers running ZBI 1.x. If you do not have a printer that meets this requirement, contact your reseller.

Note • Support for ZBI versions 1.0 through 1.5 is limited to syntax checking only.

On-printer debugging is not supported for ZBI versions 1.0 through 1.5.

48789L-002 ZBI-Developer User Guide 5/14/09

ZBI-Developer

Introduction - Welcome to ZBI-Developer

ZBI versions 2.0 and higher:

Printers with firmware versions X.16 or later (for example, V60.16.x and V53.16.x) can support ZBI version 2.0 and later. The following printers support the ZBI 2.x firmware:

• XiIIIPlus

• Z4Mplus/Z6Mplus

•105SL

•S4M

• PAX4

•ZM400/ZM600

•HC100

•G-Series

•Xi4

These printers can be either ZBI-Ready or ZBI-Enabled, depending on whether or not a ZBI Key file has been loaded on the printer. ZBI Keys can be loaded onto printers during manufacturing or later purchased at www.zebrasoftware.com

. A Downloader Utility/ZBI Key

Manager software utility is available to assist in the task of sending ZBI Keys to printers.

The ZBI.nrd file is required to be present on the printer for ZBI 2.0 to be enabled. The ZBI Key is stored on the printer’s E: memory location with the name ZBI.nrd. The file is persistent. It cannot be deleted even if the printer’s memory is initialized. For example, if the ^JB command is used to initialize the location, the ZBI Key file will not be deleted.

When a printer is ZBI-Ready but not ZBI-Enabled, the firmware version will display a "Z" at the end of the version string (for example, V60.16.0Z). Additionally, the printer’s configuration label will show that the printer is not ZBI-Enabled.

When a printer is ZBI-Enabled, the firmware version will not display a "Z" at the end of the version string (for example, V60.16.0). Additionally, the printer’s configuration label will show that the printer is ZBI-Enabled.

Note • Each single ZBI Key can only be used once. When multiple printers are to be

ZBI-Enabled, multiple Keys will be neede d. The ZBI Key cannot be retri eved from printer to a host system.

Supported Print Servers

These are the supported ZebraNet print servers:

• ZebraNet 10/100 Print Server (firmware V1.1.6 or later required to support on-printer debugging)

• ZebraNet Wireless Print Serv er (V60.16 .x , V53.16.x or later firmware required)

• ZebraNet Wireless Plus Print Server (V60.16.x, V53.16.x or later firmware required)

5/14/09 ZBI-Developer User Guide 48789L-002

ZBI-Developer

Installation

ZBI-Developer can be installed from a downloaded copy or from a CD-ROM containing the software. Before starting the ZBI-De veloper installat ion, close all other software applicati ons. This ensures a complete installation of all of the program files.

The complete installation package can be downloaded from www.zebra.com

Note • If you are using Windows 2000, Windows XP, Windows Vista or Windows Server

2003, you must log on with Administrator rights to p erform the installation.

During the installation, follow the user prompts to control the location in which to install the software and other options. If you change the default directory location for the software installation, be sure to note the new location. This information will be helpful to have for backup and archival purposes.

Once the installation is complete, click Finish to complete.

48789L-002 ZBI-Developer User Guide 5/14/09

Starting ZBI-Developer

ZBI-Developer can be started from the Windows Start menu – Start > Programs > ZBI-Developer or from any shortcuts created for the ZbiDeveloper.exe file.

When the program is run for the first time, the default interface, or workspace, will be displayed.

ZBI-Developer

Installation

5/14/09 ZBI-Developer User Guide 48789L-002

ZBI-Developer

The Interface

The ZBI-Developer interface is designed to give the user quick access to the key features needed to develop ZBI programs. The interface is divided int o various vi sual elements; thes e include the Menu bar, Toolbars, Perspectives, Views, and Editors that make up the interface.

• Menu and Toolbars – display quick access to the various functions and features of ZBI-Developer

• Projects – used to manage the files associated with creating a ZBI program

• Perspectives – display different use modes for the software:

• ZBI Perspective for writing ZBI programs

• Debug Perspective for testing and checking programs.

• Views – display different information screens:

• Navigator View – used to manage Projects and files in projects

• Printer View – used to manage physical and virtual printers

• Debug View – used to display the name of the program being tested

• Breakpoints View – used to view the list of breakpoints and jump to each point

• Variable View – used to view the current value of variables in the program

• Problems View – displays Warnings and Errors detected in the ZBI program

• Ports V iew – disp lays da ta as it fl ows thro ugh ports (seri al, parallel , IP) used in a ZBI program

• Editors – Used to create and alter files. The appropriate editor is displayed for the selec ted

file type.

48789L-002 ZBI-Developer User Guide 5/14/09

Menu and Toolbars

The Menu and Toolbars are located at the top of the screen. They provide access to the File, Edit, Run, Window, and Help submenus and commonly used program features.

File Menu

The File menu enables you to create, save, close, print, import, and export resources, and exit ZBI-Developer.

New Project

To create a new Project, select File > New > New Project. The New ZBI Project Wizard will display, with prompts for creating a new Project. Use the

Wizard prompts to fill in the Project name (required). Click Finish to complete the Wizard.

ZBI-Developer

The Interface

5/14/09 ZBI-Developer User Guide 48789L-002

ZBI-Developer

The Interface

New Folder

To create a new Folder within a Project, click on a Project in the Navigator View to select it and click File > New > New Folder.

The New Folder Wizard will display, with prompts for creating the New Folder. Use the Wizards prompt to fill in the New Folder name. Click Finish to complete the Wizard.

48789L-002 ZBI-Developer User Guide 5/14/09

ZBI-Developer

The Interface

New ZBI Program

To create a new ZBI Program, select File > New > New ZBI Program. A new, Untitled ZBI program will open and display in the ZBI-Developer workspace. The program will not appear in the Project Folders until it is named and saved. To Save and Name a program, type or paste content into the program and click the File > Save menu selection.

New Untitled File

To create a new Untitled File, select File > New > New Untitled File. Untitled Files are usually created to store data importan t to the Project, suc h as data or inp ut streams that th e ZBI program will use during execution. Untitled Files can also be used to create Notes or documentation for the Project. Clicking the New Untitle d File icon has the same ef fect. A new, Untitled File will open and display in the ZBI-Developer workspace. The File will not appear in the Project Folders until it is named and saved. To Save and Name a program, type or paste content into the program and click the File > Save menu item.

5/14/09 ZBI-Developer User Guide 48789L-002

ZBI-Developer

The Interface

Import a File

To Import a file from the computer’s hard drive into a Project, select File > Import…. Fi les cannot be imported unless they are being directed into a Project.

When Import… is selected, the Import Wizard will be displayed. Use the Browse button to select the file to import. Use the Name to Import As textbox to alter the name as needed. Files with .zbi extensions will be imported as .zbi files. Other file types will retain their original file extension. If a file does not have an extension, it will be given a .txt extension.

48789L-002 ZBI-Developer User Guide 5/14/09

ZBI-Developer

The Interface

Exporting Files

To Export ZBI Programs and Encryption Key Files from the ZBI-Developer environm ent to the computer’s hard drive, click on a file and then select File > Export….

Based on the choices entered in the Export Wizard, the name of the file and the printer memory location to store it in will be written automatically into the Export file.

The purpose of the Export ZBI Program feature is to create a file that can be distributed to one or more printers. During the Export process, ZBI programs will be exported in a format for use on a printer. The program will be MIME encoded, with all REM statements removed from the program.

Note: In order for an encrypted program to be executable, the mat ching encryption key

must also be present in the printer.

If the ZBI program has been Encrypted, then the Exported file will be Encryp ted and MIME encoded. This allows the programmer to create a file that can be emailed to users without revealing proprietary information.

5/14/09 ZBI-Developer User Guide 48789L-002

ZBI-Developer

The Interface

Exporting Projects

To Export a ZBI Project to a single file on the computers hard drive, click on a Project folder and then select File > Export…

Based on the choices entered in the Export Wizard, the files in the project will be written to a single file on the hard drive.

The purpose of the Export feature is to create a file that can be distributed to one or more printers. During the Export process, ZBI programs will be exported in a format for use on a printer. The program will be MIME encoded, with all REM statements removed from the program.

48789L-002 ZBI-Developer User Guide 5/14/09

ZBI-Developer

The Interface

Exporting Encryption Keys

The Encryption Key can be Exported and then sent to the printer. This feature allows for the following scenario – a Developer can create a ZBI program and then encrypt it. The Encryption Key can then be downloaded to the printer – thus allowing later updates of the program to also be downloaded to the printer. In this way, the Developer can protect their source code, while also allowing for program updates.

To Export a ZBI Encryption Key to a single file on the computers hard drive, click on a Encryption Key file and then select File > Export…

Based on the choices entered in the Export Wizard, the Encryption Key will be written to a single file on the hard drive.

The exported file can now be sent to printers as needed.

Note • The Encryption Key must be installed on the printer by the programmer so as to

maintain control over the ability to put the Encrypted programs on printers. The Key should not be distributed to end users.

The Close menu selection will close the currently selected file.

Close All

The Close All menu selection closes all currently open files.

5/14/09 ZBI-Developer User Guide 48789L-002

ZBI-Developer

The Interface

Save

The Save menu selection w ill Save the curre ntly selected file. If the file has a .zbi ex tension, it will be saved as a ZBI program. If the file is an Untitled File, it will be necessary to give the file an extension when saving it.

In all cases, if multiple Projects exist, it is necessary to specify which Project to save the file in.

The program will display “Invalid File Name” if no name is entered or if the “.” character is used but no extension is entered.

Note • ZBI-Developer will attempt to make u se of the file extens ion associations current ly

in use in the operating system. This means that if a file is saved as a .doc file, ZBIDeveloper will attempt to call the file viewer associated with that file type.

Save As

The Save As menu selection will Save the currently selected file with the opportunity to rename the file, change the file’s extension, and alter the Project directory the file is stored in.

If the file has a .zbi extension, it will be saved as a ZBI program. If th e fil e is a n Unt itled File , it will be necessary to give the file an extension when saving it. The program will display “Invalid File Name” if no name is entered or if the “.” (period) character is used, but no extension is entered.

In all cases, if multiple Projects exist, it is necessary to specify which Project to save the file in.

Note • ZBI-Developer will attempt to make u se of the file extens ion associations current ly

in use in the operating system. This means that if a file is saved as a .doc file, ZBIDeveloper will attempt to call the file viewer associated with that file type.

Save All

The Save All menu selection will close all currently open files. If the file has a .zbi exte nsi on, it will be saved as a ZBI program. If the file is an Untitle d File, it will b e nece ssary to give the file an extension when saving it. The program will display “Invalid Fil e Name” if no name is entered or if the “.” (period) character is used but no extension is entered.

In all cases, if multiple Projects exist, it is necessary to specify which Project to save previously unsaved files in.

Note • ZBI-Developer will attempt to make u se of the file extens ion associations current ly

in use in the operating system. This means that if a file is saved as a .doc file, ZBIDeveloper will later attempt to call the file viewer associated with that file type.

48789L-002 ZBI-Developer User Guide 5/14/09

Revert

Choosing Revert will alter the content of the current Editor back to the content of the last saved file. The Revert menu choice is disabled if the editor does not contain any unsaved changes.

Rename

Rename allows the user to alter the name of a previously created Project or a file within a Project. A Folder or File must be selected for the Rename menu selection to be active. Only one Project or File can be renamed at a time.

Print allows the currently selected and open file to be printed.

ZBI-Developer

The Interface

Note • Do not confuse Revert with Undo. The Undo feature reverses you most recent

editing action, while Revert returns the contents of the editing window to the saved contents of the file.

Exit

Selecting Exit closes all open files. The program will confirm if recent unsaved changes should be saved.

Edit Menu

The Edit menu helps you alter, search, and manage fi les in the ZBI-Dev elo per editor environments.

Undo

This command will reverse the most recent edit.

Redo

The Redo feature will re-apply the last edit that was reversed by the most recent Undo action.

Cut

Removes the selected text and places it on the clipboard.

Copy

Copies the selected text to th e clipboard.

5/14/09 ZBI-Developer User Guide 48789L-002

ZBI-Developer

The Interface

Paste

Places the text currently on the clipboard in the open document at current cursor location.

Delete

Removes the currently selected item.

Note • The Delete feature can remove selected text, or an object such as a file or an entire

Project.

Select All

Selects all objects or text in the current view or editor.

Find/Replace

The Find feature is used to search the current editor for an expression. The optional Replace feature allows the user to replace an expression with another expression.

Find Next

Allows the user to search for the next occurrence of the selected text or the next occurrence of the most recently found expression.

Find Previous

Allows the user to search for the previous occurrence of the selected text or the previous occurrence of the most recently found expression.

48789L-002 ZBI-Developer User Guide 5/14/09

Word Completion

This feature is offered when editing text files. When selected, it will attempt to complete the current word.

Set Encoding

This feature is offered when viewing text and other files that are not ZBI programs. The following encoding types can be set:

• Codepage1252 (Cp1252)

•US-ASCII

•UTF-16

•UTF-16BE

•UTF-16LE

•UTF-8

• ISO-8859-1

ZBI-Developer

The Interface

To set or change the encoding type, right-click over a file and open the Properties dialog.

5/14/09 ZBI-Developer User Guide 48789L-002

ZBI-Developer

The Interface

Run Menu

Run\Debug ZBI Application

This feature will cause ZBI-Developer to execute the selected ZBI program on the Connected printer. If no printer connection has been created, the program will display an Error dialog stating “No Connection. Plea se connect to a Printer”.

Window Menu

The Window > Show Perspective and > Show View menus are used to change the current View, Perspective, and access the Preferences dialog.

A Perspective defines the set and arrangement of Views and dialogs shown in the ZBI-Developer workspace. Within the window, each Perspective shares the same set of editors.

Each Perspective provides a set of features and functions aimed at accomplishing a specific task. For example, the ZBI Perspective combines Views that you would commonly use while editing ZBI project source files. The Debug Perspective contains the Views that you would use while debugging programs. As you work in the program, you will probably switch the Perspective frequently.

There are two Perspectives in the program, ZBI and Debug.

48789L-002 ZBI-Developer User Guide 5/14/09

+ 68 hidden pages

Zebra ZBI-DEVELOPER USER MANUAL

Specifications and Main Features

Frequently Asked Questions

User Manual

Contents

About This Document

Who Should Use This Document

How This Document Is Organized

Contacts

Document Conventions

Related Documents

ZBI-Developer

Introduction - Welcome to ZBI-Developer

System Requirements

Printers, ZBI Keys & ZBI Versions

Supported Print Servers

Installation

Starting ZBI-Developer

The Interface

Menu and Toolbars

Edit Menu

Run Menu

Window Menu