Honeywell Verifier Integration Interface User manual

Verifier Integration Interface

For PX940V Printer

Command Reference

Disclaimer

Honeywell International Inc. (“HII”) reserves the right to make changes in specifications and other information contained in this document without prior notice, and the reader should in all cases consult HII to determine whether any such changes have been made. The information in this publication does not represent a commitment on the part of HII.

HII shall not be liable for technical or editorial errors or omissions contained herein; nor for incidental or consequential damages resulting from the furnishing, performance, or use of this material. HII disclaims all responsibility for the selection and use of software and/or hardware to achieve intended results.

This document contains proprietary information that is protected by copyright. All rights are reserved. No part of this document may be photocopied, reproduced, or translated into another language without the prior written consent of HII.

Web Address:

www.honeywellaidc.com

Patents

For patent information, refer to www.hsmpats.com.

TABLE OF CONTENTS

Customer Support ....................................................................................................................... vii

Technical Assistance ............................................................................................................ vii

Product Service and Repair ............................................................................................... vii

Limited Warranty ................................................................................................................... vii

Chapter 1 - Get Started ....................................................................................1

Features ............................................................................................................................................. 1

About this Manual.......................................................................................................................... 1

Interface Diagram ..........................................................................................................................2

Data Protocol ................................................................................................................................... 2

Network Interface...........................................................................................................................2

Chapter 2 - Printer and Host PC Setup.........................................................3

Set Up Printer................................................................................................................................... 3

Access the Printer Web Page............................................................................................... 3

Configure VII.............................................................................................................................. 3

Execution Mode................................................................................................................. 5

Verifier Mode.......................................................................................................................5

Command Channel, Feedback Channel, and Image Channel........................6

Set Up Host PC................................................................................................................................6

Command Channel.................................................................................................................7

Configure Command Channel.....................................................................................7

Feedback Channel................................................................................................................... 7

Configuring Feedback Channel .................................................................................. 8

Image Channel.......................................................................................................................... 8

VII Command Reference iii

Configuring Image Channel..........................................................................................8

Chapter 3 - Commands and Responses ........................................................9

Commands ........................................................................................................................................9

Response.........................................................................................................................................10

GetPrinterInfo ...............................................................................................................................11

CancelAllJobs................................................................................................................................12

GetLabelImage .............................................................................................................................13

GetPrinterStatus ..........................................................................................................................14

ImageTransfer...............................................................................................................................15

PausePrintJob...............................................................................................................................16

PrinterError ....................................................................................................................................17

PrintJobStatus..............................................................................................................................18

ReprintPrintJob ............................................................................................................................ 19

ResetVerificationResult.............................................................................................................20

ResumePrintJob...........................................................................................................................21

RetractLabel ..................................................................................................................................22

ReverifyLabel.................................................................................................................................23

SendVerificationResult.............................................................................................................. 24

SetCommandChannelPort.......................................................................................................25

SetExecutionMode......................................................................................................................26

SetFeedbackChannelPort ........................................................................................................27

SetImageChannelPort ...............................................................................................................28

SetVerifierMode............................................................................................................................ 29

VerificationResult ........................................................................................................................30

VoidLabel ........................................................................................................................................31

Error Codes.....................................................................................................................................32

Chapter 4 - Troubleshooting........................................................................ 33

Problems and Possible Solutions..........................................................................................33

Chapter 5 - Use Case Sequence Diagram .................................................. 35

Printer Error ...................................................................................................................................35

iv VII Command Reference

Print Job - Pause, Resume, Cancel .......................................................................................36

Appendix A - Verification Report .................................................................37

Sample Verification Report ......................................................................................................37

VII Command Reference v

vi VII Command Reference

Customer Support

Technical Assistance

To search our knowledge base for a solution or to log in to the Technical Support portal and report a problem, go to www.hsmcontactsupport.com.

For our latest contact information, see www.honeywellaidc.com/locations.

Product Service and Repair

Honeywell International Inc. provides service for all of its products through service centers throughout the world. To obtain warranty or non-warranty service, return your product to Honeywell (postage paid) with a copy of the dated purchase record. To learn more, go to www.honeywellaidc.com and select Service and Repair at the bottom of the page.

Limited Warranty

For warranty information, go to www.honeywellaidc.com and click Get Resources > Product Warranty.

VII Command Reference vii

viii VII Command Reference

CHAPTER

GET STARTED

The PX940V is a rugged label printer with ANSI Grade (ISO15415/15416) verification for label printing.

The Verifier Integration Interface of the PX940V printer allows you to communicate with the printer through a host PC setup. Using the Verifier Integration Interface (VII), verification data can be collected as images and XML reports.

A TCP/IP connection needs to be configured between the printer and host PC for communication.

Features

The verifier identifies and verifies the printed barcode using supported command languages.

The VII can be used for the following:

• Label validation

• Secondary Grading

• Grading Barcodes

• Storing Audit Trails

• Label Duplication Detection

• Label Serialization Detection

About this Manual

This command reference provides you information about the interface between the printer with the verifier and a host PC and a set of commands to help you create applications for the PX940V Printer.

The following abbreviations are used in this guide:

• VII - Verifier Integration Interface

VII Command Reference 1

• TPH - Thermal PrintHead

(ANSI GRADING)

Printing

VII

Printjob

DAEMON PROCESS

VII DAEMON

PROCESS

Interface Diagram

The interface between the VII and the host PC is illustrated below:

SYNC

Verification

PRINTER

HOST PC

Feedback

Command Channel

Image Channel

Feedback Channel

Image/Result

Data Protocol

XML is the data format set for the host PC to communicate with Verifier Integration Interface.

Network Interface

A TCP/IP network interface is set up for the host PC to access the printer.

Note: While one host can be connected to multiple printers, each printer can only be

connected to a single host at a time.

2 VII Command Reference

CHAPTER

PRINTER AND HOST PC SETUP

This chapter provides details to set up communication between VII and Host PC.

Set Up Printer

User can set up the printer through a web page or the printer LCD.

Access the Printer Web Page

1. Open a browser window on your PC.

2. In the location or address bar, type the printer IP address and press Enter.

3. Click Login. The login page appears.

You will be prompted to enter a username and password. The defaults are:

After logging In, you will be prompted to change the password.

Configure VII

Before being able to configure the verifier integration interface service, it must be enabled in the Manage service configuration.

To enable the verifier integration interface service through the web page, click Configure > System Settings > Manage Services.

Through the front touch panel.

• User Name: itadmin

• Password: pass

VII Command Reference 3

Once the VII is enabled in the Manage services section, you can configure VII in detail through the web page.

Click Configure > Network Services > VII.

Through the front touch panel.

The options for the VII are as follows:

• Execution Mode

• Verifier Mode

• Command Channel

• Image Channel

• Feedback Channel

4 VII Command Reference

Execution Mode

The Execution Mode allows you to control the synchronization between label printing and printed label capture and verification.

Asynchronous Mode

One label is inspected while the next label is being printed and/or having its image scanned.

Synchronous Mode

A single label is printed, image scanned and fully inspected before any other labels are printed.

The default value is Asynchronous.

Verifier Mode

The verification modes define the types of the verification process. For the VII, there are three types of verification modes:

1. Mode1 - Scan

2. Mode2 - Scan and grade

3. Mode3 - Scan, grade and control

Verifier Modes and Description

Modes Operation Description

Mode1 Scan The verifier will only scan the printed image, it will not do barcode

inspection. The host retrieves the image, analyzes it and control the printer action.

Mode2 Scan and

grade

Mode3 Scan, grade

and control

The verifier will inspect the barcode. The host controls the printer action and could also analyze the image. If the image channel is enabled from host, the label image will be sent to host, otherwise the label image will not be sent to host.

The verifier inspect barcode and do failure action handling. The host captures reports and images for storage. The barcode verification result will be sent to host via feedback channel. If image channel is enabled from host, the label image will be sent to host, otherwise the label image will not be sent to host.

For verifier modes 1 and 2, the printer will wait for the verification result from host. In Synchronous Mode on page 5, if printer does not receive verification result from host, printer will stop after printing 1 label.

In Asynchronous Mode on page 5, printer will stop after printing X number of labels depending on the label length as indicated in the table below.

VII Command Reference 5

Label number and Label Length range

Label Length Range (inches) Number of labels (X)

> 4.00 3

> 0.68 4

> 0.52 5

> 0.41 6

> 0.35 7

> 0.30 8

> 0.26 9

> 0.24 10

> 0.00 11

Command Channel, Feedback Channel, and Image Channel

Defines the port used for the host to connect to the printer. The range of the port number is 9301 - 65535.

Note: Your firewall must be configured to allow these ports to be accessible otherwise a

failure may occur.

All the three communication channels must be opened to send or receive any data from the printer. For example, if the image channel is closed, the printer cannot send raw image data to the host.

Set Up Host PC

Verifier Integration interface allows you to transfer data between printer and host and control the printer from the host.

The host PC communicates with the printer using certain commands. To send the commands, user has to set up the communication channel and configure accordingly.

The communication channels are,

• Command Channel

• Feedback Channel

• Image Channel

Command Channel

The command channel is used to issue commands from host to printer. The commands can be sent based on the feedback result received from the printer to host or to get printing information.

6 VII Command Reference

There are four types of commands that can be sent through command channel, namely,

• Query Information Command

• Configuration Command

• Printing Control Command

• Update Command

The types of commands that can be sent through the command channel from the host PC to the printer are detailed here.

Query Information command

GetPrinterInfo

GetPrinterStatus

GetLabelImage

Configure Command Channel

Setup a TCP/IP connection between host PC and printer to open the command channel.

Command channel need to be connected before connecting Feedback channel. The Feedback channel will only accept connection from Command channel's Host (same IP), else, even if it shows connection OK, there won't be any output from this channel.

Configuration command

SetExecutionMode CancelAllJobs SendVerificationResult

SetVerifierMode PausePrintJob

SetCommandChannelPort ResumePrintJob

SetFeedbackChannelPort ReprintPrintJob

SetImageChannelPort VoidLabel

ResetVerificationResult RetractLabel

Printing control command

ReverifyLabel

Update command

Feedback Channel

The feedback channel is used by the printer to send the print job status, verification result, or error result to host. These are sent by the printer automatically.

The responses from the feedback channel are:

• PrintJobStatus

• VerificationResult

• PrinterError

Configuring Feedback Channel

Setup a TCP/IP connection between the host PC and printer to open the feedback channel.

VII Command Reference 7

+ 34 hidden pages