Intermec EasyCoder PL3 Programmer's Reference Manual

EasyCoder PL-Series

Printer

Programmer's

Reference Manual

ii EasyCoder PL-Series Printer Programmer’s Reference Manual

Intermec Technologies Corporation

Corporate Headquarters

6001 36th Ave. W.

Everett, WA 98203

U.S.A.

www.intermec.com

The information contained herein is proprietary and is provided solely for the purpose of allowing customers

to operate and service Intermec-manufactured equipment and is not to be released, reproduced, or used for

any other purpose without written permission of Intermec.

Information and specifications contained in this document are subject to change without prior notice and do

not represent a commitment on the part of Intermec Technologies Corporation.

The word Intermec, the Intermec logo, Norand, ArciTech, CrossBar, Data Collection Browser, dcBrowser,

Duratherm, EasyCoder, EasyLAN, Enterprise Wireless LAN, EZBuilder, Fingerprint, i-gistics, INCA (under

license), InterDriver, Intermec Printer Network Manager, IRL, JANUS, LabelShop, Mobile Framework,

MobileLAN, Nor*Ware, Pen*Key, Precision Print, PrintSet, RoutePower, TE 2000, Trakker Antares, UAP,

Universal Access Point, and Virtual Wedge are either trademarks or registered trademarks of Intermec

Technologies Corporation.

Throughout this manual, trademarked names may be used. Rather than put a trademark ( or  ) symbol in

every occurrence of a trademarked name, we state that we are using the names only in an editorial fashion,

and to the benefit of the trademark owner, with no intention of infringement.

There are U.S. and foreign patents pending.

Bluetooth is a trademark of Bluetooth SIG, Inc., U.S.A.

EasyCoder PL-Series Printer Programmer’s Reference Manual iii

Document Change Record

This page records changes to this document. The document was originally released as version 001.

Version Date Description of Change

002 6/03 Changed Bluetooth information in Chapter 13.

iv EasyCoder PL-Series Printer Programmer’s Reference Manual

Contents

EasyCoder PL-Series Printer Programmer’s Reference Manual

v

Contents

Before You Begin................................................................................................................xv

Safety Summary.....................................................................................................xv

Safety Icons ..........................................................................................................xvi

Global Services and Support.................................................................................xvi

Who Should Read This Document? ....................................................................xvii

Related Documents .............................................................................................xvii

Programming Introduction................................................................................................... 1

Manual Conventions ........................................................................................................... 2

Getting Printer Information ................................................................................................ 2

Communications Diagnostic Mode ..................................................................................... 5

Label Coordinate System ..................................................................................................... 6

Intermec PLUS.................................................................................................................... 7

Printer Commands ..................................................................................................................... 9

Command Start Line ......................................................................................................... 10

Printer Commands ............................................................................................................ 10

Print Command ................................................................................................................ 11

Form Command................................................................................................................ 11

Journal Command............................................................................................................. 12

Units Commands .............................................................................................................. 12

Using Comments............................................................................................................... 13

Text.................................................................................................................................................... 15

Resident Font Samples....................................................................................................... 16

Text Commands................................................................................................................ 18

Font-Group Command ..................................................................................................... 19

Text Concatenation Commands........................................................................................ 20

Multiline Commands ........................................................................................................ 22

1

2

3

Contents

vi

EasyCoder PL-Series Printer Programmer’s Reference Manual

Count Command .............................................................................................................. 23

Setmag Command ............................................................................................................. 24

Scalable Text................................................................................................................................ 27

What is Scalable Text? ....................................................................................................... 28

Scale-Text Commands....................................................................................................... 28

Scale-To-Fit Commands.................................................................................................... 29

Scalable Concatenation Commands................................................................................... 30

Rotate Commands............................................................................................................. 31

Linear Bar Codes........................................................................................................................ 33

Bar Code Standards ........................................................................................................... 34

Resident Linear Bar Code Samples .................................................................................... 35

UPC and EAN/JAN Bar Codes ......................................................................................... 36

UPC/EAN Specifications ..................................................................................... 38

Code 39 or Code 3 of 9 Bar Codes.................................................................................... 38

Code 39 (3 of 9) Specifications............................................................................. 39

Code 93 or Code 9 of 3 Bar Codes.................................................................................... 40

Interleaved 2 of 5 Bar Codes.............................................................................................. 40

Interleaved 2 of 5 Specifications............................................................................ 41

Code 128 and the UCC-128 Shipping Standard ............................................................... 41

Code 128/UCC-128 Specifications ...................................................................... 42

Codabar............................................................................................................................. 42

Codabar Specifications ......................................................................................... 43

MSI Plessey Bar Codes ...................................................................................................... 43

MSI Plessey Specifications .................................................................................... 43

Postnet and Facing Identification Marks............................................................................ 43

Postnet and FIM Specifications ............................................................................ 44

Bar Code Commands ........................................................................................................ 44

Bar Code Command............................................................................................. 45

Standard Bar Codes................................................................................. 45

Bar Code Text Command .................................................................................... 46

Count Command ................................................................................................. 47

4

5

Contents

EasyCoder PL-Series Printer Programmer’s Reference Manual

vii

Two-Dimensional Bar Codes .............................................................................................. 49

What is a Two-Dimensional Bar Code?............................................................................. 50

PDF417............................................................................................................................. 50

MaxiCode.......................................................................................................................... 50

Two-Dimensional Bar Code Commands........................................................................... 51

PDF417 (Portable Data File)................................................................................ 51

MaxiCode............................................................................................................. 52

Graphics.......................................................................................................................................... 57

Box Command .................................................................................................................. 58

Line Commands ................................................................................................................ 59

Inverse-Line Commands.................................................................................................... 60

Pattern Command ............................................................................................................. 61

Graphics Commands ......................................................................................................... 62

PCX Command................................................................................................................. 63

Advanced Commands ............................................................................................................ 67

Contrast Command........................................................................................................... 68

Tone Command ................................................................................................................ 68

Justification Commands .................................................................................................... 69

Page-Width Command...................................................................................................... 69

Pace Command ................................................................................................................. 70

Auto-Pace Command ........................................................................................................ 71

No-Pace Command ........................................................................................................... 72

Wait Command................................................................................................................. 72

Speed Command ............................................................................................................... 73

SETSP Command ............................................................................................................. 73

On-Out-Of-Paper Command............................................................................................ 74

On-Feed Command .......................................................................................................... 74

6

7

8

Contents

viii

EasyCoder PL-Series Printer Programmer’s Reference Manual

Prefeed Command............................................................................................................. 76

Postfeed Command ........................................................................................................... 77

Present-At Command ........................................................................................................ 77

Country/Code Page Command ......................................................................................... 78

Using Format Files ............................................................................................................ 79

Beep Command................................................................................................................. 80

Line Print Mode.......................................................................................................................... 83

What is Line Print Mode?.................................................................................................. 84

Special Commands Using the Utility Function.................................................................. 84

Units Commands .............................................................................................................. 85

SETLP Command............................................................................................................. 85

SETLF Command............................................................................................................. 86

Moving With X and Y Coordinates ................................................................................... 87

LMARGIN Command...................................................................................................... 87

SETBOLD Command ...................................................................................................... 87

SETSP Command ............................................................................................................. 88

Page-Width and Page-Height Commands ......................................................................... 88

Special ASCII Characters................................................................................................... 89

Form Feed ............................................................................................................ 89

Backspace ............................................................................................................. 89

SETFF Command ............................................................................................................. 89

SET-TOF Command ........................................................................................................ 90

Tearing the Paper .............................................................................................................. 90

Bar Codes and Graphics .................................................................................................... 91

Bar Codes............................................................................................................. 91

Graphics............................................................................................................... 91

SETLP-Timeout Command .............................................................................................. 91

Designing a Receipt........................................................................................................... 92

Receipt Examples.................................................................................................. 92

9

Contents

EasyCoder PL-Series Printer Programmer’s Reference Manual

ix

Advanced Utilities .................................................................................................................... 95

What are the Advanced Utilities? ....................................................................................... 96

Version Utility................................................................................................................... 96

Checksum Utility .............................................................................................................. 97

DEL Utility ....................................................................................................................... 97

DIR Utility........................................................................................................................ 97

Define-File (DF) Utility .................................................................................................... 98

Type Utility....................................................................................................................... 98

Baud Utility....................................................................................................................... 99

Country/Code Page Utility................................................................................................ 99

Timeout Utility ............................................................................................................... 101

Beep Command............................................................................................................... 102

LT Command ................................................................................................................. 102

Printer Escape Commands................................................................................................. 105

Set and Read Code Command......................................................................................... 106

Status/Information .......................................................................................................... 106

Get Printer Status ............................................................................................... 107

Acknowledge Printer Reset ................................................................................. 107

Get Printer Information (GPI.LBL) ................................................................... 107

Get Extended Printer Status ............................................................................... 108

User Label Count ............................................................................................................ 108

Get User Label Count (GULC.LBL) .................................................................. 108

Reset User Label Count (RULC.LBL) ................................................................ 108

Power Off Command ...................................................................................................... 109

LCD Programming for PL-Series .................................................................................... 111

Using the Information in This Chapter ........................................................................... 112

Example 1........................................................................................................................ 112

Example 2:....................................................................................................................... 114

10

11

12

Contents

x

EasyCoder PL-Series Printer Programmer’s Reference Manual

Configuration/Control Commands .............................................................................. 117

What are the Commands in This Chapter?...................................................................... 118

Printing Parameter Values ............................................................................................... 118

Command Format........................................................................................................... 119

getvar Command................................................................................................ 119

setvar Command ................................................................................................ 119

do Command ..................................................................................................... 120

Commands and Parameters ............................................................................................. 120

Application Parameters....................................................................................... 120

appl.date................................................................................................ 120

appl.name.............................................................................................. 121

appl.version ........................................................................................... 121

Bluetooth Parameters.......................................................................................... 121

bluetooth.address................................................................................... 121

bluetooth.authentication........................................................................ 122

bluetooth.bluetooth_pin........................................................................ 122

bluetooth.date........................................................................................ 123

bluetooth.discoverable ........................................................................... 123

bluetooth.friendly_name........................................................................ 123

bluetooth.local_name ............................................................................ 124

bluetooth.version................................................................................... 124

Communications Port Parameters ...................................................................... 124

comm.parity .......................................................................................... 124

comm.baud ........................................................................................... 125

comm.stop_bits ..................................................................................... 125

Device Parameters .............................................................................................. 126

device.friendly_name............................................................................. 126

device.reset ............................................................................................ 126

device.restore_defaults ........................................................................... 126

head.latch .............................................................................................. 127

Display Parameters ............................................................................................. 127

display.contrast...................................................................................... 127

display.backlight.................................................................................... 127

display.text ............................................................................................ 128

File Parameters ................................................................................................... 128

file.delete ............................................................................................... 128

file.dir.................................................................................................... 128

file.print ................................................................................................ 129

file.rename............................................................................................. 129

file.run................................................................................................... 129

file.type.................................................................................................. 129

Input Parameter.................................................................................................. 130

input.capture ......................................................................................... 130

Media Parameters ............................................................................................... 131

media.sense_mode ................................................................................. 131

media.status........................................................................................... 131

media.tof ............................................................................................... 131

media.type............................................................................................. 132

Memory Parameters............................................................................................ 132

13

Contents

EasyCoder PL-Series Printer Programmer’s Reference Manual

xi

memory.flash_size.................................................................................. 132

memory.flash_free ................................................................................. 132

memory.ram_size................................................................................... 133

memory.ram_free .................................................................................. 133

Odometer Parameter .......................................................................................... 133

odometer.user_label_count.................................................................... 133

Power Parameters ............................................................................................... 134

power.ascii_graph.................................................................................. 134

power.dtr_power_off............................................................................. 134

power.inactivity_timeout....................................................................... 135

power.low_battery_timeout................................................................... 135

power.low_battery_shutdown................................................................ 135

power.low_battery_warning .................................................................. 136

power.percent_full................................................................................. 136

power.status........................................................................................... 136

power.voltage......................................................................................... 136

Test Function Parameters ................................................................................... 137

test.feed ................................................................................................. 137

test.print_diags ...................................................................................... 137

test.report_diags .................................................................................... 137

Networking Parameters ...................................................................................... 138

card.mac_addr....................................................................................... 138

ip.addr................................................................................................... 138

ip.dhcp.enable ....................................................................................... 138

ip.ftp.enable........................................................................................... 139

ip.gateway.............................................................................................. 139

ip.http.enable......................................................................................... 139

ip.lpd.enable.......................................................................................... 140

ip.netmask ............................................................................................. 140

ip.ping_remote ...................................................................................... 140

ip.pop3.enable....................................................................................... 141

ip.pop3.password................................................................................... 141

ip.pop3.poll........................................................................................... 141

ip.pop3.print_body ............................................................................... 142

ip.pop3.print_headers............................................................................ 142

ip.pop3.save_attachments...................................................................... 143

ip.pop3.server_addr............................................................................... 143

ip.port ................................................................................................... 144

ip.remote ............................................................................................... 144

ip.smtp.enable ....................................................................................... 144

ip.smtp.server_addr ............................................................................... 145

ip.snmp.enable ...................................................................................... 145

ip.snmp.get_community_name ............................................................. 145

ip.snmp.set_community_name.............................................................. 146

ip.snmp.create_mib ............................................................................... 146

ip.tcp.enable .......................................................................................... 147

ip.telnet.enable ...................................................................................... 147

ip.udp.enable......................................................................................... 147

wlan.associated ...................................................................................... 148

wlan.auth_type ...................................................................................... 148

wlan.current_essid ................................................................................. 148

wlan.current_tx_rate.............................................................................. 149

wlan.encryption_index .......................................................................... 149

Contents

xii

EasyCoder PL-Series Printer Programmer’s Reference Manual

wlan.encryption_key1............................................................................ 149

wlan.encryption_key2............................................................................ 150

wlan.encryption_key3............................................................................ 150

wlan.encryption_key4............................................................................ 151

wlan.encryption_mode .......................................................................... 151

wlan.essid .............................................................................................. 152

wlan.kerberos.kdc .................................................................................. 152

wlan.kerberos.mode............................................................................... 153

wlan.kerberos.password ......................................................................... 153

wlan.kerberos.realm............................................................................... 154

wlan.kerberos.username......................................................................... 154

wlan.leap_mode..................................................................................... 155

wlan.leap_password ............................................................................... 155

wlan.leap_username............................................................................... 156

wlan.operating_mode ............................................................................ 156

wlan.power_save.................................................................................... 157

wlan.preamble ....................................................................................... 157

wlan.station_name................................................................................. 158

Printer Configuration and Setup................................................................................... 159

Power Management ......................................................................................................... 160

Synchronized On/Off Control Via Printer’s DSR Line....................................... 160

Power On/Off Control.......................................................................... 160

Bluetooth Radio Control....................................................................... 160

Shutting Off the Printer Remotely...................................................................... 161

Entering Low-Power Mode When Idle............................................................... 161

Batch Files ....................................................................................................................... 161

RUN.BAT Command and File........................................................................................ 162

Re-Run Command .......................................................................................................... 162

Gap Sense and Bar Sense Commands .............................................................................. 163

Troubleshooting...................................................................................................................... 165

Interface Cables ....................................................................................................................... 169

Bi-Directional Serial Interface Cable, DB-9 to 8 Pin DIN............................................... 170

Interface Cables for Specific Terminals ............................................................................ 170

Character Tables...................................................................................................................... 173

ASCII Table Hexadecimal Values.................................................................................... 174

14

A

B

C

Contents

EasyCoder PL-Series Printer Programmer’s Reference Manual

xiii

International ISO Substitution Characters....................................................................... 174

CP850 Character Set ....................................................................................................... 175

Latin 1 Character Set....................................................................................................... 176

Font Information..................................................................................................................... 177

Font Heights ................................................................................................................... 178

Fixed-Width Fonts .......................................................................................................... 178

Proportional Width Fonts ............................................................................................... 179

Bar Code Quick Reference ................................................................................................. 183

Bar Code Quick Reference Table..................................................................................... 184

Index................................................................................................................................................. 187

D

E

I

Contents

xiv

EasyCoder PL-Series Printer Programmer’s Reference Manual

Before You Begin

EasyCoder PL-Series Printer Programmer’s Reference Manual

xv

Before You Begin

This section provides you with safety information, technical support

information, and sources for additional product information.

Safety Summary

Your safety is extremely important. Read and follow all warnings and

cautions in this document before handling and operating Intermec

equipment. You can be seriously injured, and equipment and data can be

damaged if you do not follow the safety warnings and cautions.

Do not repair or adjust alone

Do not repair or adjust energized equipment alone under any

circumstances. Someone capable of providing first aid must always be

present for your safety.

First aid

Always obtain first aid or medical attention immediately after an injury.

Never neglect an injury, no matter how slight it seems.

Resuscitation

Begin resuscitation immediately if someone is injured and stops breathing.

Any delay could result in death. To work on or near high voltage, you

should be familiar with approved industrial first aid methods.

Energized equipment

Never work on energized equipment unless authorized by a responsible

authority. Energized electrical equipment is dangerous. Electrical shock

from energized equipment can cause death. If you must perform

authorized emergency work on energized equipment, be sure that you

comply strictly with approved safety regulations.

Before You Begin

xvi

EasyCoder PL-Series Printer Programmer’s Reference Manual

Safety Icons

This section explains how to identify and understand dangers, warnings,

cautions, and notes that are in this document. You may also see icons that

tell you when to follow ESD procedures and when to take special

precautions for handling optical parts.

A warning alerts you of an operating procedure, practice, condition,

or statement that must be strictly observed to avoid death or serious

injury to the persons working on the equipment.

Avertissement: Un avertissement vous avertit d’une procédure de

fonctionnement, d’une méthode, d’un état ou d’un rapport qui doit

être strictement respecté pour éviter l’occurrence de mort ou de

blessures graves aux personnes manupulant l’équipement.

A caution alerts you to an operating procedure, practice, condition, or

statement that must be strictly observed to prevent equipment damage

or destruction, or corruption or loss of data.

Attention: Une précaution vous avertit d’une procédure de

fonctionnement, d’une méthode, d’un état ou d’un rapport qui doit

être strictement respecté pour empêcher l’endommagement ou la

destruction de l’équipement, ou l’altération ou la perte de données.

Note: Notes either provide extra information about a topic or contain

special instructions for handling a particular condition or set of

circumstances.

Global Services and Support

Warranty Information

To understand the warranty for your Intermec product, visit the Intermec

web site at http://www.intermec.com, click Support, and then click

Warranty.

Disclaimer of warranties: The sample code included in this document is

presented for reference only. The code does not necessarily represent

complete, tested programs. The code is provided “as is with all faults.” All

warranties are expressly disclaimed, including the implied warranties of

merchantability and fitness for a particular purpose.

Web Support

Visit the Intermec web site at http://www.intermec.com to download

many of our current manuals in PDF format. To order printed versions of

the Intermec manuals, contact your local Intermec representative or

distributor.

Before You Begin

EasyCoder PL-Series Printer Programmer’s Reference Manual

xvii

Visit the Intermec technical knowledge base (Knowledge Central) at

http://intermec.custhelp.com to review technical information or to request

technical support for your Intermec product.

Telephone Support

These services are available from Intermec Technologies Corporation.

Service

Description

Call 1-800-755-5505

and choose this option

Factory Repair and

On-site Repair

Request a return authorization

number for authorized service

center repair, or request an on-site

repair technician.

1

Technical Support Get technical support on your

Intermec product.

2

Service Contract

Status

Inquire about an existing

contract, renew a contract, or ask

invoicing questions.

3

Schedule Site Surveys

or Installations

Schedule a site survey, or request

a product or system installation.

4

Ordering Products Talk to sales administration, place

an order, or check the status of

your order.

5

Who Should Read This Document?

This manual details the various commands in the CPL language that allow

you to use the built in text, graphics, bar code printing and

communications capabilities of PL-Series printers.

This manual was written for users who want to write applications for and

program the PL-Series printers. A basic understanding of programming,

data communications, and networks is necessary.

Intermec EasyCoder PL3, EasyCoder PL-Series, EasyCoder PL4 Programmer's Reference Manual

Related papers

Other documents