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.
Copyright 2020 Honeywell International Inc. All rights reserved.
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
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 Referencevii
viiiVII Command Reference
CHAPTER
1
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 Reference1
•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.
2VII Command Reference
CHAPTER
PRINTER AND HOST PC SETUP
2
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.
or
Through the front touch panel.
•User Name: itadmin
•Password: pass
VII Command Reference3
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.
or
Through the front touch panel.
The options for the VII are as follows:
•Execution Mode
•Verifier Mode
•Command Channel
•Image Channel
•Feedback Channel
4VII 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
ModesOperationDescription
Mode1ScanThe 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.
Mode2Scan and
grade
Mode3Scan, 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 Reference5
Label number and Label Length range
Label Length Range (inches)Number of labels (X)
> 4.003
> 0.684
> 0.525
> 0.416
> 0.357
> 0.308
> 0.269
> 0.2410
> 0.0011
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.
6VII 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.
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 Reference7
The command channel must be open before the feedback channel as both the
channel share the same IP address.
Note: Command channel need to be connected before connecting Feedback channel,
Feedback channel will only accept connections from Command channel's Host
(same IP).
Image Channel
The image channel is used to send the label images from printer to host. The
images can be BMP or raw image data. The image data is automatically sent from
the printer without any request from the host.
The responses for the image channel are,
•ImageTransfer
Configuring Image Channel
Setup a TCP/IP connection between the host PC and printer to open the image
channel.
The Image channel must be configured if the host PC expects to receive raw image
data from the printer. If the raw image data is not needed, then the image channel
need not be configured.
8VII Command Reference
CHAPTER
3
This chapter provides details about the Commands and Responses of all the
functionality of the verifier integration interface.
Commands
COMMANDS AND RESPONSES
Command NamePurpose
GetPrinterInfoReturns the printer information such as printer serial number, printer
model etc.
CancelAllJobsTo instruct the printer to cancel all the pending print jobs.
GetLabelImageReturns label image based on label ID.
GetPrinterStatusReturns the printer status such as busy or available.
PausePrintJobTo instruct the printer to stop printing.
ReprintPrintJobTo instruct the printer to reprint the label specified by the host.
ResetVerificationResultTo reset the verification result database stored in printer.
ResumePrintJobTo instruct printer to resume from a printer pause mode.
RetractLabelTo instruct printer to retract the label specified by the host using Label ID.
PausePrintJobTo instruct the printer to stop printing.
ReprintPrintJobTo instruct the printer to reprint the label specified by the host.
ResetVerificationResultTo reset the verification result database stored in printer.
VII Command Reference9
Response
The feedback channel and image channel returns response automatically without any request from
host.
Command NamePurpose
ImageTransferTo send label image from the printer to host.
PrinterErrorTo send the printer error information to host.
PrintJobStatusTo send print job status from the printer to host.
VerificationResultTo send Barcode verification result from the printer to the host.
10VII Command Reference
GetPrinterInfo
This command returns printer information such as printer serial number, printer
model etc.
Unique identifier for the labels.
LabelID can be retrieved from PrintJobStatus, and
VerificationResult responses. The LabelID must be the LabelID
reported back in the last response by feedback channel.
Print job option should be either “Single” or “All”.
If option is “Single”, only the label specified by label ID will be reprinted.
If option is “All”, then the labels between the label specified by label ID and the last
printed label will be reprinted.
The reprint range will be from 3 to 11 which decrease when media length is
changing from small to big. Refer to Label number and Label Length range on
page 6.
For example, if the number of label is 3 and last label ID sent back to host is 5, the
host only can send back the label ID for reprint from 3 to 5.
XML Response
<VII Action="ReprintPrintJob" Status="00">
</VII>
In case of error, 'ReprintPrintJob' XML response will be as listed below:
This command is to instruct the printer to retract the label specified by host using
label ID.
XML Request
<VII Action="RetractLabel">
<LabelID>[label ID]</LabelID>
</VII>
The range of how many labels can be retracted is between 3 and 11 which decrease
when media length is changing from small to big. Refer to Label number and Label
Length range on page 6.
For example, if the number of label is 3 and last label ID sent back to host is 5, the
host only can send back the label ID for retract from 3 to 5.
XML Response
<VII Action="RetractLabel " Status="00">
</VII>
In case of error, “RetractLabel ” XML response will be as listed below:
This command is to instruct printer to re-verify a single label specified by the
LabelID.
Note: When a label has been retracted through the TPH, the original grade (first time
verified) may not be accurate anymore. This command lets you regrade the label
again.
XML Request
<VII Action="ReverifyLabel">
<LabelID>[label ID]</LabelID>
</VII>
The range of how many labels can be reverified is from 3 to 11 which decrease
when media length is changing from small to big. Refer to Label number and Label
Length range on page 6.
For example, if the number of label is 3 and last label ID sent back to host is 5, the
host only can send back the label ID for reverify from 3 to 5.
XML Response
<VII Action="ReverifyLabel " Status="00">
</VII>
In case of error, “ReverifyLabel ” XML response will be as shown below:
This response reply the status of reverify action. The verification result will be same
as normal printing verification sent from feedback channel.
For error codes, refer to Error Codes.
VII Command Reference23
SendVerificationResult
This command is to send barcode/image verification result from the host to the
printer.
In Synchronous Mode on page 5, printer will stop subsequent label printing and
wait for verification result from host. In Asynchronous Mode on page 5, printer will
stop print after all image buffer is used up.
Note: The SendVerificationResult is for verification modes 1 and 2 only.
This command is to set the port number of the feedback channel. The default value
is "9302". The range of the port numbers are 9301 - 65535.
Note: Command port 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.
XML Request
<VII Action="SetFeedbackChannelPort">
<PortNumber>[port number]</PortNumber>
</VII>
XML Response
In case of successful command execution, no response will be sent as port will be
reset to new value.
In case of error, “SetFeedbackChannelPort” XML response will be as listed below:
Note: User can reconnect to a new port from the range 9301-65535.
For error codes, refer to Error Codes.
VII Command Reference27
SetImageChannelPort
This command is to set the port number of the image channel. The default value is
"9303". The range of the port numbers are 9301 - 65535.
Note: Command port need to be connected before connecting the image channel. The
image channel will only accept connection from the same host (same IP) connected
by the command channel, else, even if it shows connection OK, there won't be any
output from this channel.
XML Request
<VII Action="SetImageChannelPort">
<PortNumber>[port number]</PortNumber>
</VII>
XML Response
In case of successful command execution, no response will be sent, as port will be
reset to new value.
In case of error, 'SetImageChannelPort" XML response will be as listed below:
This is the response to feedback barcode verification result from printer to host. If
the barcode inspection is performed by printer verifier, the verification result will
be sent to host after each label is inspected.
Note: The verification mode applicable are mode 2 and 3.
The following table details the possible causes or error and its description.
Error CodesCommandPossible CauseDescription
00NANACommand status is OK
01NAInvalid XMLWrong syntax for the respective XML
02NALabel ID Not FoundThe specified label ID cannot be found in
03NACommand ErrorError in command handling
04NAUnknown ErrorInvalid command/other errors
commands used
printer
32VII Command Reference
CHAPTER
TROUBLESHOOTING
4
Problems and Possible Solutions
ProblemsPossible Solution
The Ethernet or wireless
network connection is not working
correctly
Printing stopsMay happen on VII mode 1/2 due to missing command from
Printer does not print label in batch
mode for batch printing
Missing result/Image filesTry these possible solutions:
Printer is not voiding the full labelTry these possible solutions:
Try these possible solutions:
•Make sure your network cable is securely connected to
your printer and is straight pin-to-pin cable, not a
crossover cable.
•Make sure your PC is correctly configured for and
connected to your network.
•Make sure your printer is correctly configured for your
network.
Host to printer. Drop the current connection and force the
printer to discard its current state.
Try these possible solutions:
•Lower the printing speed.
•Reduce the network route (move the printer and host pc
to the same network).
•Use Ethernet connection instead of Wireless
connection.
•Reset Verification result by UI/Webpage/VII command.
•Lower the printing speed.
•Reduce the network route (move the printer and host pc
to the same network).
•Use Ethernet connection instead of Wireless
connection.
•Change the Host application implementation dedicated
process/thread for receiving data rather than using the
same thread/process for receiving and data handling.
•Set the correct void length in printer setting
•Adjust the TPH pressure to avoid media slipping.
VII Command Reference33
ProblemsPossible Solution
Not able to connect to printerTry these possible solutions:
•Check network status, and make sure your host PC is
able to ping the printer IP address.
•Check your printer setting, and make sure your printer
VII service is enabled.
•Check your printer setting, and make sure the expected
VII ports are used.
•Printer might be connected to another Host PC,
disconnect the current connection.
•Check your Host PC port, and make sure VII ports are
not being used by other processes.
•Check your firewall setting, make sure VII ports are not
blocked by firewall.
Image data is not received•Try these possible solutions:
•Check network status, and make sure your host PC is
able to ping the printer IP address
•Check your printer setting, and make sure your printer
VII service is enabled.
•Check your printer setting, and make sure the expected
VII ports are used.
•Printer might be connected to another Host PC,
disconnect the current connection.
•Check your Host PC port, and make sure VII ports are
not being used by other processes.
•Check your firewall setting, make sure VII ports are not
blocked by firewall.
Report data is not receivedTry these possible solutions:
•Check network status, and make sure your host PC is
able to ping the printer IP address.
•Check your printer setting, and make sure your printer
VII service is enabled.
•Check your printer setting, and make sure the expected
VII ports are used.
•Printer might be connected to another Host PC,
disconnect the current connection.
•Check your Host PC port, and make sure VII ports are
not being used by other processes.
•Check your firewall setting, make sure VII ports are not
blocked by firewall.
Image data is not received in real
time
Try these possible solutions:
•Reduce print speed
•Reduce traffic congestion on network
34VII Command Reference
CHAPTER
USE CASE SEQUENCE DIAGRAM
5
Printer Error
The use case show when printer error happen before/during printing.
VII Command Reference35
Print Job - Pause, Resume, Cancel
This use case displays the host request to Pause/Print/Cancel print job.
Note: The pause will be executed on the next label.