release 2.0 user guide - ncr corporation · 1 chapter 1: overview introduction the ncr print...

NCR Print Assistant Release 2.0

User Guide

B005-0000-1703 Issue C

The product described in this book is a licensed product of NCR Corporation.

NCR is a registered trademark of NCR Corporation.

NCR RealPOS, NCR RealPrice, NCR RealScan, NCR EasyPoint and NCR FastLane are either registered trademarks or trademarks of NCR Corporation in the United States and/or other countries.

This software contains paintlib code. paintlib is copyright (c) 1996‐2002 Ulrich von Zadow and other contributors.. The following are the libraries used by PaintLib

LibTIff ‐ Copyright (c) 1988‐1997 Sam Leffler. Copyright (c) 1991‐1997 Silicon Graphics, Inc.

Zlib ‐ zlib software copyright © 1995‐2005 Jean‐loup Gailly and Mark Adler.

LibPNG ‐ libpng copyright 1995‐2009 Guy Eric Schalnat, Andreas Dilger, Glenn Randers‐Pehrson

LibJpeg ‐ Copyright (C) 1991‐1997, Thomas G. Lane. Independent JPEG Groupʹs software.

It is the policy of NCR Corporation (NCR) to improve products as new technology, components, software, and firmware become available. NCR, therefore, reserves the right to change specifications without prior notice.

All features, functions, and operations described herein may not be marketed by NCR in all parts of the world. In some instances, photographs are of equipment prototypes. Therefore, before using this document, consult with your NCR representative or NCR office for information that is applicable and current.

To maintain the quality of our publications, we need your comments on the accuracy, clarity, organization, and value of this book.

Address correspondence to:

Manager, Information Products NCR Corporation 2651 Satellite Blvd. Duluth, GA 30096

Copyright © 2009 By NCR Corporation Dayton, Ohio U.S.A. All Rights Reserved

i

Preface Audience This guide is targeted to end users who need to know how the Graphics Utility works and how to optimize the graphics capability of the NCR Printers. This book is also written to NCR Professional Services, ISVs and NCR Sales.

Note: This document is NCR proprietary information and is not to be disclosed or reproduced without consent.

ii

References • NCR 7156 Thermal Receipt & Impact Slip Printer (RS‐232) Ownerʹs

Userʹs Guide (BD20‐1436‐A)

• NCR 7158 thermal Receipt and Impact Slip Printer Ownerʹs Guide (B005‐0000‐1112)

• NCR RealPOS 7167 Two‐Station POS Printer Ownerʹs Manual (B005‐0000‐1406)

• NCR 7168 Two‐Station POS Printer Ownerʹs Guide (B005‐0000‐1713)

• NCR 7193 Thermal Receipt Printer Ownerʹs Guide (BD20‐1439‐A)

• NCR 7196 Thermal Receipt Printer OperatorʹsManual (B005‐0000‐1171)

• NCR RealPOS 7197 Receipt Printer Ownerʹs Manual(B005‐0000‐1409_)

• NCR 7198 Receipt Printer Ownerʹs Guide (B005‐0000‐1736)

• NCR 7342‐F306 Self‐Service Receipt PrinterOwnerʹs Manual (B005‐0000‐1541)

• NCR 7346‐F309 2ST Self‐Service Receipt Printer Ownerʹs Guide (B005‐0000‐1816)

• NCR 7401‐K580 Self‐Service Printer Ownerʹs Guide(B005‐0000‐1140)

• NCR 7401‐K59x Self‐Service Printer Ownerʹs Guide(B005‐0000‐1346)

iii

Table of Contents

Chapter 1: Overview Introduction........................................................................................... 1-1 Functionality Description.................................................................... 1-2

Bit Image ......................................................................................... 1-2 User-Defined Character ................................................................ 1-3 Two-Sided Image ........................................................................... 1-3

Chapter 2: Utility Setup Installation............................................................................................. 2-1 Settings................................................................................................... 2-3

Resolution ....................................................................................... 2-3 Paper Size........................................................................................ 2-3

Chapter 3: Using the Image Feature Introduction........................................................................................... 3-1 Image Functions ................................................................................... 3-2

Starting the Utility ......................................................................... 3-2 Connecting to a Serial Port ........................................................... 3-3 Loading an Image to the Utility................................................... 3-5

Image Conversion from Bitmap to Monochrome ................. 3-6 Resizing a Bitmap Image .............................................................. 3-8

Zoom-IN ..................................................................................... 3-8 Zoom-OUT ................................................................................. 3-8

Changing the Image Alignment .................................................. 3-9 Adjusting Image Brightness ....................................................... 3-10 Adjusting Image Contrast........................................................... 3-10 Saving an Image to Disk ............................................................. 3-10

iv

Loading a Saved Image on Disk ................................................ 3-11 Making a Binary File of the Loaded Image .............................. 3-12 Sending an Image to Printer’s RAM/Flash Memory.............. 3-13 Printing a Downloaded Image in the Printer........................... 3-15 Sending and Printing an Image ................................................. 3-16 Erasing Downloaded Images in the Printer’s Memory .......... 3-18

Chapter 4: Using the User-Defined Characters Feature Introduction........................................................................................... 4-1 User-Defined Character Functions .................................................... 4-2

Understanding Character Types and Code Page ...................... 4-2 Character Type........................................................................... 4-2 Code Page ................................................................................... 4-3

Starting the Utility ......................................................................... 4-3 Adding a Character ....................................................................... 4-5

Assigning a Memory Location................................................. 4-7 Defining an Added Character ...................................................... 4-7 Deleting a Character ...................................................................... 4-8 Copying and Pasting a Character ................................................ 4-8 Clearing a Characters .................................................................... 4-9 Making a Binary File of the Character ........................................ 4-9 Saving a Character to Disk ......................................................... 4-11 Loading a Character from Disk.................................................. 4-12 Sending a Character to Printer’s RAM/Flash Memory.......... 4-13 Printing a Downloaded Character in the Printer .................... 4-14 Sending and Printing a Character to the Printer ..................... 4-15 Erasing All User-Defined Characters in the Printer’s Memory ......................................................................................... 4-16

Chapter 5: Using the Two–Sided Image Feature Introduction........................................................................................... 5-1

v

Two–Sided Image Creation Functions .............................................. 5-3 Starting the Utility ......................................................................... 5-3 Setting the Working Directory ..................................................... 5-7 Loading All Definitions................................................................. 5-7 Saving All Definitions ................................................................... 5-8 Setting Macro Options................................................................... 5-9 Connecting to a Serial Port ......................................................... 5-11 Defining a Print Element............................................................. 5-13

Common Functions in Defining Print Elements ................. 5-14 Print Line Definitions.............................................................. 5-17 Barcode Definitions ................................................................. 5-23 Bit Image Filename Association ............................................ 5-29 Bottom Front Message Definition ......................................... 5-33 Reverse Side Top Message Definition .................................. 5-37 Reprint on Error Message Definition.................................... 5-41

Defining a Page Mode Object..................................................... 5-45 Creating a New Object............................................................ 5-46 Setting the Logical Origin....................................................... 5-47 Inserting Print Elements ......................................................... 5-48 Arranging the Print Elements ................................................ 5-51 Saving the Page Mode Object ................................................ 5-52 Test Printing the Object .......................................................... 5-53 Deleting the Page Mode Object ............................................. 5-53

Defining a Macro Image.............................................................. 5-54 Creating a New Macro Image................................................ 5-55 Inserting a Print Element or Page Mode Object .................. 5-56 Arranging the Objects ............................................................. 5-57 Saving the Macro Image Definition ...................................... 5-58 Test Printing the Macro Image Definition ........................... 5-59 Deleting a Macro Image Definition....................................... 5-59

Data Storage Formats......................................................................... 5-60

vi

Overview....................................................................................... 5-60 Print Line Definition.................................................................... 5-62 Barcode Definition ....................................................................... 5-66 Bit Image Filename Association................................................. 5-68 Reverse Side Top Message.......................................................... 5-69 Bottom Front Message................................................................. 5-71 Reprint on Error Message ........................................................... 5-72 Page Mode Object ........................................................................ 5-72 Macro Image Definition .............................................................. 5-74

Printer Escape Sequences .................................................................. 5-76 Print Line Definition.................................................................... 5-76

Font Size.................................................................................... 5-76 Alignment ................................................................................. 5-77 Rotation..................................................................................... 5-77 Attribute Marker...................................................................... 5-78 Variable Text Marker .............................................................. 5-79

Barcode Definition ....................................................................... 5-79 Bit Image Filename Association................................................. 5-81 Reverse Side Top Message.......................................................... 5-82 Bottom Front Message................................................................. 5-83 Reprint on Error Message ........................................................... 5-84 Page Mode Object ........................................................................ 5-85

Start of Page Mode Object Commands................................. 5-85 Page Mode Element Object Commands............................... 5-86 End Page Mode........................................................................ 5-88 Image Macro Definition.......................................................... 5-88

Set Macro Options........................................................................ 5-90 Miscellaneous Two–Sided Thermal Commands..................... 5-92

Real–Time Command to Obtain Current Two–Sided Print Mode................................................................................ 5-92 Command to Set Current Two–Sided Print Mode ............. 5-93

viii

Revision Record

Issue Date Remarks

A May 2006 Initial release

B May 2008 Added Two‐Sided Image Creation Enhancement

C Jun 2009 Updated for release 2.0

1

Chapter 1: Overview

Introduction The NCR Print Assistant is a standalone utility that permits you to download images, user‐defined characters and two‐sided images directly into a printer, or generate a binary file that can be transmitted to the printer using another utility to load files for later use or perform the printing operation there

The NCR Print Assistant is not intended for a particular hardware platform. It is designed to work with the following NCR Printers.

The two‐sided printers include: NCR 7168, 7198, and 734x‐F309.

The single sided printers include: NCR 7156, 7158, 7167, 7193, 7194, 7197, F306, F307, K580, and K590.

Some functionality, such as two sided printing, may not be available depending on the features of a particular printer.

This utility demonstrates the graphics capabilities of these NCR printers making them more intuitive and user‐friendly, and for the most part, providing customers the freedom to personalize receipt/slip logos according to their business needs.

1-2 Chapter 1: Overview

Functionality Description The NCR Print Assistant is specifically designed to send bitmap images, user‐defined characters and two‐sided images to the printer.

Bit Image Following are functions provided by the utility for bitmap images:

• Converts BMP, JPEG, GIF and TIFF files into printer Native Bit image format. The only image formats supported by NCR Printers are bitmap‐based formats.

• Loads converted bitmap into memory and displays a preview of the image on a simulated receipt showing how it appears on the paper.

• Clicking the Zoom buttons to scale the bitmap, making it larger or smaller when printed on the receipt.

• Defines the logo position (right, center, left align) in the printer memory.

• Deletes currently‐defined bitmaps in the printer memory before loading new ones.

• Saves images into the printer memory.

• Loads all the bitmaps that have been defined for the printer in one operation.

• Generates a binary file that is used to send the images to the printer using another utility.

• Prints the images on the selected printer.

Note: Refer to Chapter 3: Using the Image Feature for detailed instructions for each of these functions.

Chapter 1: Overview 1-3

User-Defined Character Following are functions provided by the utility for user‐defined characters:

• Selects one or more characters you want to define.

• Saves and loads your definitions for later changes and modifications.

• Defines the Display Grid (user‐defined character preview) that shows each pixel for the character, including the spacing pixels that cannot be changed, but are a part of the character.

• Generates a binary file to send or load user‐defined characters to the printer.

• Saves user‐defined characters into the printer memory.

• Sends the characters to the selected printer then prints them.

• Deletes all downloaded user‐defined characters in the printer’s memory before loading new characters.

Note: Refer to Chapter 4: Using the User‐Defined Characters Feature for detailed instructions for each of these functions.

Two-Sided Image The utility provides the following functions for two‐sided images:

• Defines Print Elements that can be lines of text, barcodes, bitmap images and messages.

• Defines Page Mode Objects which is composed of previously defined Print Elements.

• Defines Image Macro Definitions consist of a list of Print Elements and Page Mode Objects arranged to create the desired print image.

1-4 Chapter 1: Overview

• Saves and loads your definitions for later use.

• Generates a binary file containing all printer commands necessary that define the Image Macros.

• Sends your definitions directly to the printer and prints them.

• Permits you to set additional commands sent together with your definitions.

Note: Refer to Chapter 5: Using the Two‐Sided Image Feature for details on each of these functions.

2

Chapter 2: Utility Setup

Installation The NCR Print Assistant is a standalone utility that can be downloaded from the NCR External Website under the Drivers and Patches section. Ensure that you have a file archive software such as WinZip installed on the terminal as this will be used throughout the process. Follow this link to display the web page:

http://www5.ncr.com/support/support_drivers_patches.asp?Class=External/Peripherals\NCRPrintAssistant\display

To start the installation, open the Readme.TXT file on the web page or perform the following steps:

1. Download and run the NCRPrintAssistantInstall.exe file.

2. Once it finishes downloading, a self‐extractor window pops up; select Unzip to start extracting the files.

Note: You can choose the directory where you want to extract the files by selecting Browse. By default, the files are extracted to the C:\NCRPrintAssistantInstall directory.

3. Locate the directory where you chose to extract the files in step 2 and open the NCRPrintAssistantInstall folder.

4. Run the Setup.Exe file to begin installing the utility; the NCRPrintAssistant Setup Wizard displays and runs you through the installation process. Follow the instructions on the wizard properly.

http://www5.ncr.com/support/support_drivers_patches.asp?Class=External/Peripherals%5CNCRPrintAssistant%5Cdisplay

http://www5.ncr.com/support/support_drivers_patches.asp?Class=External/Peripherals%5CNCRPrintAssistant%5Cdisplay

2-2 Chapter 2: Utility Setup

Note: By default, NCRPrintAssistant.exe is saved on the C:\Program Files\NCR\NCRPrintAssistant directory.

5. After the utility is successfully installed, a shortcut of the executable file is created on both the desktop and under Start Programs NCR OLE for Retail. The Windows Installer Merge module is also executed for the required system files (MFC70.DLL, GDIPLUS.DLL) and installs these files if they are not present on the terminal.

Chapter 2: Utility Setup 2-3

Settings

Resolution NCR printers in the Retail environment are designed for various print functions: receipts, sales slips, check endorsement, and so forth. This includes text, low resolution graphic images, and high resolution graphics images such as JPEG, GIF and TIFF.

Paper Size Receipt printing can be either Graphic Images or User‐Defined Characters; the paper must be 80 mm (3.175 in) wide. You can use a 58 mm receipt paper however, it is not recommended to use the Fit to Paper function as the entire image may not be accommodated on the actual receipt. Use the Zoom Out function instead until the image fits perfectly on the receipt paper when printed (refer to the ResizingBitmap Image section of Chapter 3 for more information on these functions). For slip printing, only User‐Defined Character printing is available; the size is determined by the printer capabilities.

Note: Large images must be scaled or converted to print properly. Logo positioning is also affected if images are too big for the paper size.

3

Chapter 3: Using the Image Feature

Introduction The NCR Print Assistant Image Feature permits you to send, load, and print images. This feature is not only limited to low‐resolution graphic images; it also supports hi‐resolution images such as JPEG, GIF, and TIFF.

This section contains procedures for the following functions:

• Connecting to a Serial Port

• Loading an Image to the Utility

• Resizing a Bitmap Image

• Changing the Image Alignment

• Adjusting Image Brightness

• Adjusting Image Contrast

• Saving an Image to Disk

• Loading a Saved Image on Disk

• Making a Binary File of the Loaded Image

• Sending an Image to Printer’s RAM/Flash Memory

• Printing a Downloaded Image in the Printer

• Sending and Printing an Image

• Erasing Downloaded Images in the Printer’s Memory

3-2 Chapter 3: Using the Image Feature

Image Functions Before you can perform any of these functions, ensure that you have already installed the NCR Print Assistant to the terminal. Refer to the Installation section of Chapter 2 for detailed instructions on installing the utility.

Starting the Utility 1. From the Start Menu, select Start Run.

2. On the Run command window, type the location where the utility is stored (for example, C:\Program Files\) then select OK. The Directory View displays.

3. Select NCRPrintAssistant.exe; the following window displays:

Chapter 3: Using the Image Feature 3-3

4. Select File New Image or click the New Image icon ; the Image Definitions window displays.

Picture Box

Connecting to a Serial Port A connection must exist between the printer and the terminal before printing can be performed. Follow these steps:

1. Ensure that printer is connected to a serial COM port in the terminal and then turn the printer ON.


2. Check the serial port configuration by using Device Manager. If necessary, refer to the terminal documentation. Take note of the serial port settings: number, baud rate, data bits, parity bits, stop bits, and data flow.

3. In the Printer Properties box in the NCRPrintAssistantUtility, select the Printer Model.

Note: The Image feature of the current version of the NCRPrintAssistant only supports receipt printing with a paper size of 80 mm (3.175 in) wide.


4. In the menu bar on the NCRPrintAssistant window, select Printer Connect; this configuration dialog box displays:

5. Select and change settings for serial port as necessary – these

settings must match those defined in Device Manager.

6. Select OK to go back to the Image Definitions window.

7. When you wish to disconnect the serial port connection, select Printer Disconnect in the menu bar.

Loading an Image to the Utility Use the following steps to load an image to be printed, into the utility:

1. Select Load Image for Editing button; the Open dialog box displays.

2. Locate the folder where the desired image is stored and select the image.


Note: The utility supports images with BMP, JPEG, TIFF, GIF, and NCR image formats. The NCR image format is used when you Save an image to disk using the NCR Print Assistant Utility.

3. Select Open.

Note: At this point, the bitmap image is now in monochrome bitmap (1‐bit) format. For detailed information about image conversion, refer to Image Conversion from Bitmap to Monochrome in this section.

4. The image is now displayed in a simulated receipt similar to its appearance on paper.

Note: If the original size of selected image is larger in width and height than picture box, the image is scaled down to fit the picture box. Otherwise, the original size is displayed.

Image Conversion from Bitmap to Monochrome The prefix “mono” in the word monochrome means one. A monochrome image is created with one foreground color superimposed over a background medium of a different color. For example, black ink on white paper produces a black and white monochrome image. If various shades of the foreground color are used, the image is more accurately known as a grayscale image.

The output shading of the converted monochrome image highly depends on the color quality and resolution of the original image. Consider the following examples.


16 color Bitmap

256-color Bitmap

24 bit image


Resizing a Bitmap Image Using the Zoom buttons, you can change the scaling of the bitmap image making it larger or smaller when printed on the receipt.

Zoom-IN 1. Load an image to the utility. (Refer to Loading an Image to the

Utility.)

2. In the Image Controls group box, click the Zoom‐In button. This increases the size without affecting the image alignment, brightness, or contrast.

Note: Each time you click the Zoom‐In button, the image size increases. This can occur until the maximum image size is reached; the Zoom‐In and Fit to Paper buttons are then disabled. The maximum size is scaled based on the maximum printable area.

Zoom-OUT 1. Load an image to the utility.


2. In the Image Controls group box, click the Zoom Out button. This decreases the image size without affecting the image alignment, brightness, or contrast.

Note: Each time you click the Zoom‐Out button, the image size decreases. This can occur until the minimum image size is reached; the Zoom‐Out button is then disabled.

Fit to paper

1. Load an image to the utility.

2. In the Image Controls group box, click the Fit to Paper button. This increases the image size to its maximum size; the Zoom‐In and Fit to Paper buttons are then disabled.

Note: The Image feature of the current version of the NCRPrintAssistant only supports 80 mm (width) size of receipt paper. If you are using a 58 mm (width) receipt paper, it is not recommended to use the Fit to Paper function as the entire image may not be accommodated and only a part of the image is printed on the actual receipt. Use the Zoom‐Out button instead until the desired image fits perfectly on the paper when printed.

Changing the Image Alignment The NCRPrintAssistant provides three radio buttons that define where the image is aligned: left, right, or center. To change the image alignment, follow these steps:


2. In the Image Controls group box, click Left Align, Center Align, or Right Align to change to the desired alignment.

Note: Changing the alignment of the image does not affect its size, brightness, or contrast.


Adjusting Image Brightness Perform the following steps to adjust the image brightness:


2. In the Image Controls group box, drag Brightness slider to the left to reduce image brightness, or to the right to increase it. You can also change the brightness by entering a value within the range of 0 – ±100 in the box next to the slider.

Note: Adjusting the brightness of an image does not affect its size, alignment, or contrast.

Adjusting Image Contrast Perform these steps to adjust the image contrast:


2. In the Image Controls group box, drag Contrast slider to the left to reduce the image contrast, or to the right to increase it. You can also change the contrast by entering a value within the range of 0 – ±100 in the box next to the slider.

Note: Adjusting the contrast of an image does not affect its size, alignment, or brightness.

Saving an Image to Disk Bitmap images loaded and saved in this feature can be utilized in the Two‐Sided Image Feature of the Utility. Therefore, when saving bit images to disk, you must select a specific directory location (the default is the directory where the PrintAssistant.exe file is located) to store all your images. This location is accessed as soon as you learn to define image macros (refer to Chapter 5 for more information about the Two‐Sided Image Feature). Perform the following instructions to save the image to the hard disk:


1. Load an image to the utility and make necessary changes to its properties.

2. Select Save Image to Disk button; the Save As dialog box displays.

3. Enter a filename for the image and select the folder where you want to save it.

4. Select Save.

At this point, the image is saved with a file type defined as NCRImage Files (*.NCRImage).

Loading a Saved Image on Disk Saved images on hard disk can be loaded back to the utility for additional changes and modifications. Use the following steps:

1. Select Load Image for Editing button; the Open dialog box displays.

2. Locate the folder where you saved the image. Under Files of type, select NCR Image Files (*.NCRImage). Select the desired image.

3. Select Open.

4. The image displays in the Image Definitions window. The image is now displayed in the simulated receipt.

5. Make necessary changes to its properties using the Image Controls section, if needed.


Making a Binary File of the Loaded Image Binary files contain the actual data bits of the image, its properties (such as alignment, brightness, size), and the commands for loading the image to the printer and printing it. Without using the NCRPrintAssistant, you can test the printer’s image printing feature using another utility such as TRCOMW (a DOS‐based executable program) that sends the binary file directly to the serial port. The generated binary files are often used for testing with other utilities. Use the following steps to generate a binary file:


2. Select Make Binary File button; this dialog box displays:

3. Select Image No. from 0 – 255. The selected number maps to the

corresponding memory location where the image is actually stored on Flash or RAM.

Note: Selecting the numbers does not have to be in sequential order as long as it is within the range of 0 – 255. An image location (image number) can only accommodate one image at a time; therefore, you must take note of the numbers you have already used to assign an image to avoid overwriting it with another one.

4. Select the Location (Load to Flash or RAM). The utility then inserts a command in the binary file that determines the printer memory where the image will be loaded once it is sent to the printer.


Note: Loading to RAM temporarily stores the image into memory and is deleted as soon as the printer is turned OFF. Conversely, loading to Flash memory permanently stores the image even in the absence of a power source.

5. Select OK to proceed; the Save As dialog box displays and the file type defaults to Binary Files (*.bin).

6. Enter a filename for the binary file.

7. Select Save; a message box displays: “Binary file creation successful”

Note: You can open the saved binary file using any hex editor.

8. Save TRCOMW.exe to the C:\ directory. This is available from the NCR Print Assistant web page.

9. Open command prompt by selecting Start Run in the Start Menu, type cmd, then select OK.

10. Go to the root directory C:\ or the location where you saved the TRCOMW.exe.

11. Type “TRCOMW [filename].bin [baud rate] [COM port] [time out] [max time wait]”. Press Enter key.

Note: For filename, type the name of the binary file. Baud rate and COM port values can be obtained at the Device Manager. Time out and max time wait values are by default, set to zero (0).

12. A progress bar appears and a text displays “FILE TRANSMISSION : [filename].bin”.

13. The image should now be printed properly on the receipt.

Sending an Image to Printer’s RAM/Flash Memory Perform the following steps to send an image to the printer’s RAM/Flash Memory:


1. Connect printer to an available serial COM port and turn printer ON. Refer to Connecting to a Serial Port to achieve connection between terminal and printer.

Note: The settings shown on the Printer Port Configuration must match the actual port settings.

2. Select the Printer Model in the Printer Properties group box.


4. Select the Send Image button; this properties dialog box displays:

5. In Image Location, select printer memory where you want to save

the image (Load to Flash or RAM).


6. Select the Image Number from 0 – 255. The selected number maps to the corresponding memory location where the image is actually stored on Flash or RAM.



7. Leave Erase All Loaded Images unchecked if you do not want to delete currently‐defined images in the printer’s Flash or RAM before loading a new one. Otherwise, place a check mark.

8. Select OK.

Printing a Downloaded Image in the Printer You can print an image that was previously downloaded to the printer by following these steps:




3. Select the Print Image button; this dialog box displays:

4. Select the Image No. of the image you want to print.


5. Select OK to proceed (the image should print on the receipt) or Cancel to discontinue action.

6. When finished, disconnect the serial port by selecting Printer Disconnect in the menu bar on the NCRPrintAssistant window.

7. Turn the printer OFF.

Sending and Printing an Image Perform the following steps to send an image to the printer and print it:






4. Select the Send and Print Image button; this properties dialog box displays:

5. In Image Location, select whether you want to load the image to

printer’s RAM or Flash memory.


6. Select the Image Number from 0 – 255. The selected number maps to the corresponding memory location where the image is actually stored on Flash or RAM.


7. Leave Erase All Loaded Images unchecked if you do not want to delete currently‐defined images in the printer’s Flash or RAM. Otherwise, place a check mark.


8. Select OK to proceed (the image is printed on the receipt) or Cancel to discontinue action.

9. When finished, disconnect serial port by selecting Printer Disconnect in the menu bar on the NCRPrintAssistant window.

10. Turn printer OFF.

Erasing Downloaded Images in the Printer’s Memory Prior to loading new images to the printer, you have an option to delete all images previously downloaded to the printer’s memory:




3. Select the Erase All Images button; this dialog box displays:

6. If you are sure to wipe out all the images in the printer memory

(Flash and RAM), select Yes; otherwise, select No.


7. As the utility deletes all the characters in the printer memory, several messages display showing the progress of the erase operation.



4

Chapter 4: Using the User-Defined Characters Feature

Introduction The NCR Print Assistant User‐Defined Characters Feature permits you to define characters according to your needs, then send and print it. This feature also provides you the freedom to create your own font styles and sizes.

This section contains procedures for the following functions:

• Adding Characters

• Defining Added Characters

• Deleting Characters

• Copying and Pasting Characters

• Clearing Characters

• Making a Binary File of the Characters

• Saving Characters to Disk

• Loading Characters from Disk

• Sending Characters to Printer’s RAM/Flash Memory

• Printing Downloaded Characters in the Printer

• Sending and Printing Characters to the Printer

• Erasing All User‐Defined Characters in the Printer’s Memory

4-2 Chapter 4: Using the User-Defined Characters Feature

User-Defined Character Functions Before you can perform any of these functions, ensure that you have already installed the NCR Print Assistant to the terminal. Refer to the Installation section of Chapter 2 for detailed instructions on installing the utility.

Understanding Character Types and Code Page Before you begin using the User‐Defined Character feature, it is imperative that you understand the significance of selecting the appropriate character type and code page as you define your own characters.

Character Type This feature deals with two types of characters: single byte and double byte characters. A single byte character, by the name itself, refers to a character that is exactly one byte (8 bits or binary digits) long; thus, it can accommodate up to a maximum of 256 (28) different characters. This may be sufficient to hold all the characters of languages that use the Roman alphabet‐based letters as well as numbers, punctuations, and other special characters. Examples of these languages are English, Spanish, German, French, Turkish languages, and so forth.

However, some international languages may have alphabets with more than 256 characters such as Korean, Japanese, and Chinese languages. Double byte characters (16 bits) introduce a solution to this limitation of single byte characters which can accommodate a maximum of 65,536 (216) different characters.

Chapter 4: Using the User-Defined Characters Feature 4-3

Code Page A code page is a list of character codes that are usually defined to support a specific language or a group of languages that use a common writing system. For example, the 437 – US English code page contains standard characters that are required in the English language. Another good example is the 852 – Slavic code page which supports a closely‐related group of languages of people indigenously living in some parts of Europe and northern Asia.


2. On the Run command window, type the location where the utility is stored (for example, C:\Program Files\) then select OK. The Directory View displays.

3. Select NCRPrintAssistant.exe. The following window displays:


4. Select File New User‐Defined Character or click the New User

Defined Character icon ; this dialog box displays:

5. Select the character type (single byte or double byte character) and

the corresponding code page. Refer to Understanding Character Types and Code Pages at the beginning of this chapter for further insights about selecting the appropriate character type and code page.

Note: Code pages are used by the printer to determine what type of characters the user defines.

6. Select the character size. This determines the pixel dimension (width x height) of the display‐grid where you define the character. For example, the 10x24 dimension represents 10 rows and 24 columns of pixels in the display‐grid.


Note: By default, the Predefined Character size option is selected which defines a 10x24 grid for the single byte character type and 16x16 for the double byte character type. You can also customize your own size by selecting the Custom Size radio button then input the values of its width and height to adjust the display‐grid. Toggling between either of the options disables the other.

7. Select OK to proceed; the Add Characters window displays. See the next section.

Adding a Character Use the following steps to add a character to the utility:

1. The Add Characters window is shown after you define the character set or when you select the Add Character button; this window displays:

2. Input the Number of characters you would like to define. The

maximum allowable number of characters is 224.

Note: Since it was mentioned at the beginning of the chapter (refer to Understanding Character Types and Code Pages) that the utility can accommodate 256 characters, only 224 characters are allowable because the remaining 32 are actually reserved for control characters such as linefeed (LF) and escape (ESC), among others.


3. Select the Starting Location of the characters within the range of 0020H – 00FFH (32 – 255 in decimal). The location is expressed in hexadecimal (hex) value which also defines the starting memory location where the user‐defined characters are actually stored when sent to the printer memory later. The End Location automatically points to the address location of the last character. The End Location field is disabled, and therefore cannot be changed. Refer to Assigning Memory Locations for more information.)

If you input a Hex value lesser than 0020H for the starting location, the following error message displays:

If a memory location has been defined twice, another type of error message displays:

Simply select OK on the message box to bypass these errors. If you input 00FFH (last allowable memory location) as the starting location, the utility starts pointing from 00FFH and then going backwards to the prior memory addresses (00FEH 00FDH 00FCH) to accommodate the number of characters defined.

4. Select OK to proceed or Cancel to discontinue action.


Assigning a Memory Location In this feature, the starting memory location for user‐defined characters always starts at 0020H. The reason for this, as explained in step 2, is that memory locations from 0000H – 001FH (0 – 31 in decimal) which is equivalent to 32 addresses are reserved for control characters such as linefeed (LF) and escape (ESC).

Defining an Added Character After adding characters to the utility, you can start defining each character using the display‐grid on the bottom portion of the window. The display‐grid defines each pixel for the characters, including the spacing pixels that cannot be changed, but are a part of the characters.

Memory Location

Character Preview Box

Display‐grid


To shade a pixel (black), click the pixel on the display‐grid using your mouse, or drag it over the grid to form characters. To clear a pixel (white), simply click the shaded pixel again. Toggling the pixels changes the shade to black or white.

Deleting a Character Characters can only be deleted one at a time. To delete a specific character, follow these steps:

1. On the upper portion of the window, select the character preview box of the character you want to delete.

2. Select Delete Characters button. The following confirmation window displays:

3. Select Yes to proceed or No to discontinue deletion. If you click

Yes, the remaining character preview boxes on the right of the deleted character, shifts one box to the left.

Copying and Pasting a Character To copy and paste a user‐defined character, follow these steps:

1. On the upper portion of the window, select the character preview box of the character you want to copy.

2. Select Copy Character button. No obvious changes occur at his point.


3. Select the character preview box where you want to paste the character.

4. Select Paste Character button. A copy of the selected character will now appear at the new location.

Clearing a Characters Use the following steps to clear out a character definition:

1. Select the character preview box that you want to clear.

2. Select Clear Character button. This removes all the black shading in the selected preview box and changes all pixels back to white.

Making a Binary File of the Character Binary files contain the actual data bits of the character definitions, its properties (such as character type, character size), and the commands for loading the characters to the printer and printing it. Without using the NCRPrintAssistant, you can test the printer’s character printing feature using another utility such as TRCOMW (a DOS‐based executable program) that sends the binary file directly to the serial port. The generated binary files are often used for testing with other utilities. Use the following steps to generate a binary file:

1. Add and define characters to the utility.


2. Select Make Binary File button; this dialog box displays:

3. Select Memory Location (Load to Flash or RAM). The utility then

inserts a command on the binary file that determines the printer memory where the image will be loaded once it is sent to the printer.

Note: Loading to RAM temporarily stores the characters into memory and are deleted as soon as the printer is turned OFF. Conversely, loading to Flash memory permanently stores the characters even in the absence of a power source.

4. Leave Erase All Loaded Characters unchecked if you do not want to delete currently‐defined characters in the printer memory before loading a new one. Otherwise, place a check mark.

5. Select OK to proceed; the Save As dialog box displays and the file type defaults to Binary Files (*.bin).

6. Enter a filename for the binary file.

7. Select Save; this message box displays: “Binary file creation successful”

Note: You can open the saved binary file using any hex editor.

9. Save TRCOMW.exe to the C:\ directory.

10. Open command prompt by selecting Start Run in the Start Menu, type cmd, then select OK.


11. Go to the root directory C:\ or the location where you saved the TRCOMW.exe.

12. Type “TRCOMW [filename].bin [baud rate] [COM port] [time out] [max time wait]”. Press Enter key.

Note: For filename, type the name of the binary file. Baud rate and COM port values can be obtained at the Device Manager. Time out and max time wait values is by default, set to zero (0).

13. A progress bar appears and a text displays “FILE TRANSMISSION : [filename].bin”.

14. The image should now be printed properly on the receipt.

Saving a Character to Disk Perform the following steps to save the user‐defined character to hard disk:


2. Select Save Characters to Disk button. The Save As dialog box displays.

3. Enter a filename for the characters and locate the folder where you want to save them.

4. Select Save to proceed or Cancel to discontinue action. When the image is saved, a confirmation message displays for a few seconds.

Note: The characters are saved with a file type of NCR Font File (*.fnt).

5. You can now load the file at anytime for added changes and manipulation.


Loading a Character from Disk Saved characters on the hard disk can be loaded for added changes and modifications. Follow these steps:

1. Select Load Characters from Disk button. The Open dialog box displays.

2. Locate the folder where you saved the image. Under Files of type, select NCR Font File (*.fnt). Select the desired image.

3. Select Open. An information window showing the properties of the user‐defined characters displays:

4. Check if properties are correct, select OK to proceed; the saved

characters are now displayed on the preview window and a confirmation message displays for a few seconds stating that the operation was successful.

5. Make necessary changes to its properties if needed.


Sending a Character to Printer’s RAM/Flash Memory Perform the following steps to send characters to the printer’s RAM/Flash memory:

1. Connect printer to an available serial COM port and turn printer ON. Refer to the Connecting to a Serial Port section of Chapter 3 to achieve connection between terminal and printer.



3. If you selected 7167 printer in step 2, select the Station Type to determine whether you want to use the printer’s receipt or slip printing functionality.

Note: The paper size supported for slip printing is determined by the printer capabilities.


5. Select Send Characters button; the following dialog box displays. If the printer is not connected, you are asked to connect the printer first.

6. In Memory Location, select the printer memory where you want to

load the characters.


Note: Loading to RAM temporarily stores the characters into memory and is deleted as soon as the printer is turned OFF. Conversely, loading to Flash memory permanently stores the characters even in the absence of a power source.


8. Select OK to proceed or Cancel to discontinue action; a confirmation message box displays saying that the characters are successfully sent to the printer’s Flash memory.

Printing a Downloaded Character in the Printer You can print characters that were previously downloaded to the printer by following these steps:






4. Select Print Characters button; all the user‐defined characters are printed on the receipt/slip. The characters should now be printed properly on the receipt/slip.




Sending and Printing a Character to the Printer Perform the following steps to send characters to the printer and then print them:








5. Select Send and Print Characters button; the following dialog box displays:

6. In Memory Location, select whether you want to load the characters to printer’s RAM or Flash memory.


8. Select OK; the defined character set should now be printed properly on the receipt/slip.



Erasing All User-Defined Characters in the Printer’s Memory Prior to loading new characters to the printer, you have an option to delete all user‐defined characters in the printer memory:








5. Select Erase All User‐Defined Chars button; this dialog box displays:

6. If you are sure to wipe out all user‐defined characters in the printer

memory (Flash and RAM), select Yes; otherwise, select No.

7. As the utility deletes all the characters in the printer memory, several messages display showing the progress of the erase operation.


9. Select OK and turn printer OFF.

5

Chapter 5: Using the Two–Sided Image Feature

Introduction The NCR Print Assistant Two–Sided Image Feature permits you to create static Macro Image Definitions for use as static images on the reverse side of a two–sided thermal printer that can then be downloaded to the printer. The image can either be printed on the back side of the receipt, or front side if the application uses single–sided print commands. The Two–Sided Image feature is designed to work with the 7168 Two–Station POS Printer. To learn more about this product, refer to the NCR 7168 Two–Station POS Printer Owner’s Manual (B005–0000–1713).

This feature can immediately download the image definition to a connected printer to perform a test print. Similar to the Image and User Defined Character functions, it can also generate a binary file containing the definitions and transmit to the printer to load the image for later use.

The Two–Sided Image Feature operates by defining first the three types of print objects. They are described as follows:

1. Print Elements

• Consist of print commands and associated parameters that define lines of text, barcodes, bit images and messages.

2. Page Mode Objects

• Consist of a Page Mode definition composed of previously defined Print Elements positioned on a page with Page Mode commands.

5–2 Chapter 5: Using the Two–Sided Image Feature

3. Macro Image Definitions

• Consist of a list of Print Elements and Page Mode Objects arranged to create the desired print image stored as a Macro definition. It results in a binary file that can be transmitted to the printer to store the Macro definition at the printer. This Macro can then be used as the reverse side image.

4. It then permits you to print one of these Macro Image Definitions to use as the pre–defined reverse side image. The Utility is capable of defining multiple instances of each type of object. You can save the definitions for each type of objects to disk in order to recall it for later use and editing.

Chapter 5: Using the Two–Sided Image Feature 5–3

Two–Sided Image Creation Functions Before you can perform any of the Two–Sided Image Creation functions, ensure that you have already installed the NCR Print Assistant to the terminal. Refer to the Installation section of Chapter 2 for detailed instructions on installing the Utility.


2. On the Run command window, type the location where the Utility is stored (for example, C:\Program Files\) then select OK. The Directory View displays.

3. Select NCRPrintAssistant.exe. The following window displays:


4. Select File New Two–Sided Image or click the New Two–Sided

Image icon on the toolbar; the Two–Sided Image Definitions window displays:

This screen is your point of entry to the main Two–Sided Image functions. The following table generally describes how each of the functions operate:


Button/Function Description

Printer Model Select your printer model from the drop‐down list.

Set Working Directory Sets the location where you save all your definitions. Refer to Setting the Working Directory in the succeeding section for more information.

Print Elements Permits you to access the functions for defining the basic elements such as text lines, barcodes, bit images, bottom front messages, top back messages, and reprint on error messages. All Print Element definitions are stored or loaded to or from a file called PRTELEMENTS.NCRgcu. Refer to Defining a Print Element for more information.

Page Mode Objects Permits you to access the printer page mode area where you can combine and arrange the different Print Elements previously defined. All Page Mode Objects are stored or loaded to or from a file called PAGEMODEOBJECTS.NCRgcu. Refer to Defining a Page Mode Object in the succeeding sections.

Macro Image Definitions Permits you to access the function that generates the Macro Image Definition. All Macro Image Definitions are stored or loaded to or from a file called IMAGEMACRODEFINITIONS.NCRgcu. Refer to Defining a Macro Image for more


Button/Function Description

information.

Load All Definitions Loads all the Print Elements currently stored in the terminal. Refer to Loading All Definitions for more information.

Save All Definitions Saves all Print Elements and two–sided definitions to their respective files in the terminal. Refer to Saving All Definitions for more information.

Make Macros Binary File Permits you to create a binary file containing all printer commands necessary to define the Macro Image Definitions. You can send the data directly to the printer to define the image. You can select a single image or all images to be generated at once. Refer to Setting Macro Options for further information.

Download Macros to Printer Permits you to define additional printer commands and send it to the printer together with the Macro Image Definitions. You can send the data directly to the printer to define the image. You can select a single image or all images to be generated at once. Refer to Setting Macro Options for further information.

Set Macro Options Permits you to define additional commands sent together with the macro definitions when Make Macros Binary or Download Macros to Printer is selected.


Setting the Working Directory The Current Working Directory is the location where you save all your definitions. It is recommended that you use the same directory where you stored the bitmap images (refer to Saving an Image to Disk in Chapter 3). This way, the Utility automatically defaults to this directory as soon as you begin to associate bit images to your definitions (refer to Bit Image File Associations for more information). To set the working directory, perform these steps:

1. From the Two–Sided Image Definitions screen, select Set Working Directory; the Browse for Folder window displays.

2. Locate the directory where you want to save your definitions. Expand the folders by selecting the + sign next to it.


4. The Current Working Directory now displays the chosen directory.

Note: The Set Working Directory option is also available in the File Menu once you access the Two–Sided Image Definitions 1 screen.

Loading All Definitions After setting the working directory (refer to previous section), you can load all the definitions you previously created and saved on that directory. Use the following steps to load all definitions:

1. Select Load All Definitions from the Two–Sided Image Definitions window. Notice that the Number Currently Defined static boxes are now updated appropriately.


Saving All Definitions This function permits you to save all definitions you are currently defining or modifying. As you exit from the main window where you make the definitions, it is imperative that you perform the save before exiting from the Two–Sided Image Definitions window; otherwise, any changes made to the definitions are lost. Use the following steps to perform the save:

1. From the Two–Sided Image Definitions window, select Save All definitions; this confirmation message box displays:

2. Select OK to confirm saving the Two–Sided definitions.


Setting Macro Options

This function permits you to define additional commands for the Macro Image Definition. If items are not currently valid, they are grayed out. If you select either Make Macros Binary or Download Macros to Printer from the Two–Sided Image Definitions screen, these commands are sent to the printer together with the Macro Image Definition. However, if you select Set Macro Options, only the defined additional commands are sent to the printer. The following shows the definitions of the options in the Set Macro Options window:


Option Default Value / Description

Generate OPOS/JasvaPOS Reverse Image File(s)

This is only available if Make Macros Binary File is selected. If you select it, none of the other options are available

Erase Previous Macros

Default value: unchecked

This permits you to select whether you want to erase previously–downloaded macros or not.

Active Macro as Reverse Side Image

If you selected either Make Macros Binary or Download Macros to Printer to get to the Set Macro Options window, then Utility checks this box by default. The drop box shows the Macro definition number selected (1 to 25), or if ALL was selected, then it shows a list of all Image Macro Definitions in memory.

If you selected Set Macro Options to get to this window, then this box is unchecked by default. Manually checking this box permits you to select the Macro definition from 1–25.

Set Reverse Side Orientation


If checked, this permits you to set the orientation of the Macro Image Definition as it is sent to the printer. The following are the options:

• 0 Degrees (Normal)

• 180 Degrees (Upside Down)

Set/Erase Top Bottom Receipt Messages


If checked, the commands for either settings or erasing pre–defined Bottom Front Message, Reverse Top Message, and Reprint on Error


Option Default Value / Description

Message are sent out based on the definition number selected in the corresponding drop‐down boxes in the dialog.

Enable/Disable Top Bottom Reprint Message


If checked, you can enable or disable Bottom Front Message, Reverse Top Message, Reprint on Error Message, or Reprint Functionality Message.

Connecting to a Serial Port A connection between the terminal and printer must exist before printing can be performed. Perform the following steps:

1. Ensure that printer is connected to a serial COM port in the terminal and then turn printer ON.

2. Check the serial port configuration by using the Device Manager. If necessary, refer to the terminal documentation. Take note of the serial port settings: number, baud rate, data bits, parity bits, stop bits, and data flow.


3. In the menu bar on the NCRPrintAssistant window, select Printer Connect, the following configuration box displays:

4. Select and change settings for serial port as necessary — these

settings must match those defined in Device Manager.

5. Select OK to go back to the previous window.

6. To disconnect the serial port connection, select Printer Disconnect in the menu bar on the NCRPrintAssistant window.


Defining a Print Element Print Elements comprise the Page Mode Objects, and arranging both together produce the final Macro Image Definition. Fundamentally, Print Elements form the foundation of any Macro Image Definition. This option permits you to define basic elements such as lines of text, barcodes, bit images, bottom front and top back receipt messages, and reprint on error messages. To begin defining these individual Print Elements, follow these steps:

1. From the Two–Sided Image Definitions screen, select Print Elements button; the following screen displays:


1. Select the Print Element you want to define from the screen by selecting the corresponding button. The static boxes parallel to each button display the corresponding total number of current definitions.

Note: Procedures and descriptions in defining each individual Print Element are further explained in the following sections.

Common Functions in Defining Print Elements As you define the different Print Elements in the Two–Sided feature of this Utility, you encounter some common functions which you can familiarize as soon as you start defining them. The following table shows these functions:

Function Description / Procedure

Saving the Print Element

To save the current Print Element definition in the terminal, select Store Entry; the Utility places a check mark in the Currently Stored checkbox. If this is a new definition you are making, the Utility creates a new memory record (object); otherwise, the existing memory record is updated.

The Currently Stored function only acts as an indicator, whether the current definition is already saved in a memory record or not, which explains why this function is disabled. After saving the Print Element, as soon as you change any settings like changing the Logical Origin, inserting or deleting a Print Element from the list, the Currently Stored check box is unchecked indicating that these updates are not saved.

If Store Entry is not selected, any changes



made to the definition are lost in three ways:

• When Add New is selected wiping out your current changes, and displaying default values for all options

• When you select a different definition from the Current Definition list and all other options display the properties associated with the selected definition

• When the Print Element definition window is closed

Test Printing the Print Element

Test printing permits you to observe the Print Element’s actual appearance on the receipt. This command places the printer in single–sided mode, then sends the current definition to the printer’s RAM for temporary storage and prints it.

If the Print Element definition is not yet saved, the Utility disables the Test function. Refer to the preceding item for more information on saving the Print Element. Perform the following steps to test print your Print Element definition:





2. Select Test; the definition should now be printed on the receipt.

The Utility then erases and disables the message, and restores the printer back to its previous mode for which it was configured.

Deleting the Print Element

Perform the following steps to delete the current Print Element definition:

Select Delete Current. The number defined is decremented. The Utility removes the record associated with the current definition and adjusts the numbers of the remaining definitions, displaying the details of the next higher number. If there are no more definitions remaining in the list, the same default values as defined when you add a new definition are displayed.

Example: If there are 5 definitions (1,2,3,4,5), with 3 being the current display, selecting Delete Current removes the definition associated with 3 and displays the definition of the next higher number, which in this case would be Definition 4.

The next time you add a new definition, the Utility uses the missing numbers first before it adds a new number at the end of the Current Definition list. In the preceding example, selecting Add New displays 3 in Current Definition. The next addition displays 6.


Print Line Definitions This Print Element permits you to define the contents of a single line or group of lines and specify attributes to associate with specific lines. You can also insert dynamically–defined print variables called Variable Text Markers. Selecting Print Line Definitions from the Print Elements screen displays the following window:


If no definitions exist yet, all the options display their default values. The following table defines these values:

Option Default Value

Current Definition 0

Number Defined 0

Number of Lines in Current Definition

0

Font Size Normal

Character Size Normal

Character Attributes All boxes are unchecked.

Text Alignment Left

Text Rotation 0 Degrees (Normal)

Currently Stored Checkbox is not checked.

If definitions already exist, the Number Defined static box displays the total number of current definitions. All the other options are filled in appropriately showing the details of the highest–numbered definition.

Example: If there 5 current definitions, then Number Defined displays 5 and the rest of the options show the details associated with that definition.

Adding a Print Line Definition

To add a print line definition, select Add New; the Number Defined value is incremented and the next available number in the Current Definition list sequence is displayed.

If you have deleted definitions prior to the addition of a new print line entry, the Utility uses those deleted (missing) numbers in the middle of the Current Definition list sequence first; otherwise, a new number is added at the end of the list sequence.


After adding a new definition, the Text for Defined Lines text box is enabled, and only contains an Attribute Marker 0 (refer to Inserting and Deleting Attribute Markers) and a Line Feed (LF). The value of Number of Lines in Current Definition is 1. This is a static field that increments as the user types characters and hits a carriage return, displaying another blank line in the text box.

Setting the Font Size

The length of each text line depends on the font size selected of whether it is Normal (44 characters per line) or Compressed (56 characters per line). Once that number of characters is reached as you type, it automatically adds a line feed and brings the cursor to the beginning of the next line. The Utility adjusts the number of characters in each line if the character size is changed. Characters of Double High or Double Wide character sizes are counted as 2 characters in the characters–per–line text count.

Example: If you select Normal for the font size and Double Wide for the character size, then only 22 characters are displayed in a line before a line feed is added.

Inserting and Deleting Attribute Markers

Attribute Markers are points in the text line representing variations of the character size and attributes in between the markers. All the characters after each marker share a common size and attributes, whereas those before it may have different attributes associated with them. Attribute Markers are displayed as Inverse Video numbers and are not counted as characters in the line.


To insert a marker, select Insert Attribute Marker. The Utility inserts the attribute marker at the current cursor position and the number displayed represents the total number of markers defined. By default, there is always an Attribute Marker 0 at the beginning of the text.

To delete a marker, select Delete Attribute Marker. It only deletes a marker immediately to the left of the cursor. If there is no marker to the left, then nothing happens. Once the attribute marker is deleted, all the characters associated to that marker (characters to the right of the marker) automatically adapt the character size and attributes of the characters to the left of that marker.

In the memory record, the attribute marker is represented by a two–byte sequence that is not sent to the printer. This should be 1E, nn where nn is a value from 1 to 255 (decimal) that represents the marker number. Every Print Line Definition has a marker 0 (1E, 00) which is the default used if no other markers are inserted. In the following example, 0 and 1 are the attribute markers displayed in the Utility in Inverse Video format.

Example: 0The quick brown fox 1jumps over the lazy dog.

Setting the Character Size

The Character Size group box is mutually exclusive which means that no two options under the box can be selected at the same time. You can only pick one item to set characters in between attribute markers. The default size is Normal. If you select the Scale by Value option, then the Vertical and Horizontal combo boxes are activated permitting you to select a range from 1 to 8.


Setting the Character Attributes

Any of the attributes can be selected to associate with characters between attribute markers, except for the following pair of options which are mutually exclusive which means you cannot select both options at one time:

• SuperScript and SubScript

• Underline 1 Dot and Underline 2 Dots

Inserting Variable Text Marker Numbers

This button permits you to insert a marker into the static text that prints a variable that the application can change at runtime. Perform the following steps to insert a variable text marker:

1. Select Insert Variable Text Marker Number; this dialog box displays:

2. Select the Text Marker # from 1 to 50 that identifies the message to

print; select the Length or the maximum number of characters you expect to be printed.



4. The Utility inserts three special characters <|> in the text window which are not counted in the text count. The number between the first two characters <| is the Text Marker # and between the second two characters |> is the maximum character length.

Example: “The quick brown fox named <10|8> jumps over the lazy dog”

In the above example, only the characters “The quick brown fox named” and “jumps over the lazy dog” are included in the text count, so the LF for the next line is inserted at the character y in the word “lazy”. When editing the text, if you hit DEL or BACKSPACE keys while the cursor in the text window is on any of the characters in this special sequence <10|8>, then the entire marker is deleted.

Setting the Text Alignment

The Text Alignment group box is mutually exclusive which means that only one of its options can be selected at a time. The default alignment is Left Aligned and the selection applies to all the lines in the text window.

Setting the Text Rotation

Similar to Text Alignment, the Text Rotation group box is also mutually exclusive wherein only one option can be active at a time. The default setting is 0 Degrees. If you select 90 or 270 Degrees, the lines are re–arranged when sent to the printer.


Note: To save, test print, or delete the current print line definition, refer to Common Functions in Defining Print Elements for the detailed procedure.

Note: As soon as you exit from the Print Line Definitions window, always remember to select Save All Definitions to save what you have created or modified to the working directory. Refer to Saving All Definitions for further information and instructions.

Barcode Definitions This Print Element permits you to define the contents of a barcode including all of the attributes that can be associated with the barcode such as symbology, height, width, printing of Human Readable Interpretation, alignment on the receipt, and rotation of the barcode. From the Print Elements screen, selecting Barcodes displays the following screen:


If no barcode definitions exist yet in the Utility, only the Add New button is available. All the options in the window display their default values. The following table defines these values:



Number Defined 0

Barcode Symbology Blank indicating none is selected.

Human Readable Interpretation (HRI)

Not Printed

HRI Character Size Standard

Barcode Height in Dots 162

Integral Bar Width 2

Barcode Data Blank indicating no values.

Barcode Alignment Center

Barcode Rotation 0 Degrees (Normal)


If barcode definitions already exist, the Number Defined static box displays the total number of definitions. All the other options are filled in appropriately showing the details of the highest–numbered definition.

Adding a Barcode Definition

To add a new barcode entry, select Add New; the Number Defined value is incremented and the next available number in the Current Definition list sequence is displayed.


If a definition was deleted prior to the addition, the Utility uses the deleted (missing) numbers in the middle of the Current Definition list sequence; otherwise it increments a new number at the end of the sequence. All other options are set to their default values.

Selecting the Barcode Symbology

In a barcode, different bar and space patterns represent different characters. When these set of patterns are grouped together, they form what we call a “symbology”. Different types of barcode symbologies have their own special characteristics and features. The following is a list of symbologies available in the Utility:

• UPC–A

• UPC–E

• JAN13

• JAN8

• CODE 39

• INTERLEAVED 2 of 5 (ITF)

• CODABAR

• CODE 93

• CODE 128

• PDF 417

The default option is blank indicating that none is selected. For possible values that you can input in each type, refer to Inputting Barcode Data section.


Setting the Human Readable Interpretation

Human Readable Interpretation or HRI are the letters and digits associated and printed along with the barcode. They are called so because these characters can be read by humans whereas the barcode can only be read by a machine such as the scanner.

The Human Readable Interpretation dropdown list permits you to select whether you want the HRI to be printed or not, and its location in reference to the barcode. Options in the list are as follows:

• Not Printed (default)

• Above

• Below

• Above and Below

Setting the HRI Size

You can select the size of the HRI as it is printed along with the barcode on the receipt. There are only two options available in the list: Standard (15.2 characters per inch) and Compressed (19 characters per inch).

Adjusting the Barcode Height

The height of the barcode is measured in dots. Adjust the barcode height by selecting from the dropdown list a value within the range of 1–255; default value is 162 dots.


Adjusting the Integral Bar Width

Adjust the width of the barcode by selecting from the dropdown list a value within the range of 1–6; default value is 2.

Inputting Barcode Data

The values and length of the barcode data depends on the Barcode Symbology selected. The following table shows the permissible values and lengths of each symbology:

Barcode Symbology Value Length

UPC–A Numeric only Minimum: 11 Maximum: 12

UPC–E Numeric only 6 digits

JAN13 Numeric only Minimum: 12 Maximum: 13

JAN8 Numeric only Minimum: 7 Maximum: 8

CODE 39 ASCII Alphabetic (does not accept lowercase letters) and Numeric

Variable length

INTERLEAVED 2 of 5 (ITF)

Numeric only Variable length

CODABAR ASCII Alphabetic and Numeric. The value must begin and end with either “A”, “B”, “C”, or “D”.

Variable length


Barcode Symbology Value Length

The starting letter should be the same as the ending letter.

CODE 93 ASCII Alphabetic and Numeric

Variable length

CODE 128 ASCII Alphabetic and Numeric. This accepts lowercase letters only of Character Set B.

Variable length

PDF 417 ASCII Alphabetic and Numeric

Variable length

As you input data to your barcode definition, you cannot view the actual barcode in the Utility. You can use the Test function instead and perform a test print on your definition to view its actual appearance on the receipt. For more information on the Test function, refer to Test Printing Your Barcode Definition section.

Setting the Barcode Alignment

This option sets the alignment of the barcode relative to the receipt. The Barcode Alignment group box is mutually exclusive. This means that no two options can be active at the same time. Default alignment is Center.


Setting the Barcode Rotation

This option sets the orientation of the barcode relative to the receipt. Similar to the Barcode Alignment, only one option in this group box can be active at one time. Default rotation is 0 Degrees (Normal). If you select 90 or 270 Degrees, the data is re–arranged when sent to the printer.

Note: To save, test print, or delete the current barcode definition, refer to Common Functions in Defining Print Elements for detailed procedures.

Note: As soon as you exit from the Barcode Definitions window, always remember to select Save All Definitions to save what you have created or modified to the working directory. Refer to Saving All Definitions for further information and instructions.

Bit Image Filename Association This Print Element permits you to define a logo position for a bitmap image. It must be an image loaded and saved from the Image feature of the Utility (refer to Chapter 3 for more information about this feature). These files have a filename extension of .NCRImage.


Selecting Bit Images from the Print Elements screen displays the following window:

If there are no existing definitions yet, all the options display their default values. The following table defines these values.



Image Association Number 0

Number Defined 0

Pre–Defined Image Filename

Blank indicating none is selected.

Bitmap Print Alignment Center


If there are existing image associations, the Number Defined static box displays the total number of associations. The rest of the options display the details of the highest–numbered definition.

Selecting a specific Image Association Number in the dropdown list displays the image, its filename and alignment. The valid range of association numbers is from 30 to 255 (decimal) to prevent conflict with OPOS Bitmaps.

Adding a Bit Image

Select Add New to add a new association entry; the Number Defined value is incremented and the next available number in the Current Definition list sequence is displayed.

Note: If you have deleted definitions prior to the addition of a new entry, the Utility uses those deleted (missing) numbers in the Current Definition list sequence first before adding the next available number at the end of the sequence.


Associating a Bit Image to a New Entry

To associate a bitmap image to the new entry, select the Pre–Defined Image Filename drop down list to display all of the files with the .NCRImage extension in the Current Working Directory. This list only contains filenames that are not yet associated with an Image Association Number. Once you select a file, the corresponding image is displayed on the Selected Image box.

Setting the Image Alignment

This option sets the alignment of the image relative to the receipt. The Bitmap Print Alignment group box is mutually exclusive which means that only one of the alignment options can be selected at one time. Default alignment is Center.

Note: To save, test print, or delete the current image association, refer to Common Functions in Defining Print Elements for detailed procedures.

Note: As soon as you exit from the Bit Image Filename Associations window, always remember to select Save All Definitions to save what you have created or modified to the working directory. Refer to Saving All Definitions for further information and instructions.


Bottom Front Message Definition This Print Element permits you to define a special message printed at the bottom front side of the receipt when the printer is in two–sided mode. Selecting Bottom Front Message from the Print Elements screen displays the following window:


If no bottom front message definitions exist yet in the Utility, all the options in the window display their default values. The following table shows these values:



Number Defined 0

Text for Line #1 Blank indicating none is defined.


Character Attributes Line #1 All boxes are unchecked.



If definitions already exist, the Number Defined static box displays the total number of definitions. The rest of the options are filled in appropriately showing the details of the highest–numbered definition.

Adding a Bottom Front Message Definition

To add a new message definition entry, use the following steps:

1. Select Add New; the Number Defined value is incremented and the next available number in the Current Definition list sequence is displayed.

Note: If you have deleted definitions prior to the addition of a new entry, the Utility uses those deleted (missing) numbers inmiddle of the Current Definition list sequence first, before a new one is added at the end of the list.

the


2. Type your desired message under Text for Line #1 and Text for Line #2 text boxes.

3. Make necessary changes to your text by selecting the attributes you

want to associate with each of the lines. Refer to Setting the Character Attributes for more information.


You can select any of the attributes that you want to associate with the text except for Underline 1 Dot and Underline 2 Dot options which are mutually exclusive. Only one of these two options can be selected at one time.

Each line of text in the definition is provided a separate group of character attributes to let you choose your desired format in each line. As you select attributes for formatting the text, changes in the text format cannot be viewed in the Utility. You can perform a test print instead by selecting Test as Bottom Front Message to view the actual message definition on the receipt.


When you exit from the Bottom Front Message window, always remember to select Save All Definitions to save what you have created or modified to the working directory. Refer to Saving All Definitions for further information and instructions.

Note: To save, test print, or delete the current bottom front message definition, refer to Common Functions in Defining Print Elements for detailed instructions.

Note: If you change the Logical Origin or Length from Logical Origin, you probably want to modify the Distance from Logical Origin under the Insert Print Element section.

Note: The Alternate Color attribute is not available for 2‐sided paper.


Reverse Side Top Message Definition This Print Element permits the user to define a special message printed at the top of the reverse side of the receipt when the printer is in two–sided mode. Selecting Top Back Messages from the Print Elements screen displays the following window:


If there are no existing reverse side top message definitions yet, all the options in the window display their default values. The following table shows these values:



Number Defined 0






If message definitions already exist, the Number Defined static box displays the total number of definitions and the rest of the options are appropriately set to show the details of the current definition.

Adding a Reverse Side Top Message Definition

Perform the following steps to add a new message entry:

1. Select Add New; the Number Defined value is incremented and the next available number in the Current Definition list sequence is displayed.

Note: If you have deleted definitions prior to this addition, the deleted (missing) numbers in the middle of the Current Definition list sequence are used first, before a new number is appended at the end of the sequence.


2. Type your desired message under the Text for Line #1 and Text for Line #2 text boxes.


want to associate with the lines. Refer to Setting the Character Attributes for more information.


You can associate any of the character attributes to the line of text except for Underline 1 Dot and Underline 2 Dot options which are mutually exclusive. This means that only one of these two options can be selected at one time.

Each line of text in the definition is provided a separate group of character attributes to let you select your desired format in each line. As you select attributes for formatting your text, you cannot view the changes in the text format in the Utility. You can use the Test as Bottom Front Message function instead to view the actual message definition on the receipt.


When you exit from the Reverse Side Top Messages window, always remember to select Save All Definitions to save what you have created or modified to the working directory. Refer to Saving All Definitions for further information and instructions.

Note: To save, test print, or delete the current reverse side top message definition, refer to Common Functions in Defining Print Elemfor detailed instruction

ents s.


Note: When you select Test as Bottom Front Message, the message prints as a Bottom Front Message, but when you actually print, the message will be printed as a Reverse Side Top Message.


Reprint on Error Message Definition This function permits you to define a special message printed on the receipt every time an error occurs. Selecting Reprint Messages from the Print Elements screen displays the following window:


If no definitions exist yet, all the options in the screen display their default values. The following table shows these values.



Number Defined 0






If message definitions already exist, the Number Defined static box displays the total number of definitions and the rest of the options are appropriately set to show the details of the current definition.

Adding a Reprint on Error Message Definition

To add a new message definition, perform the following steps:

1. Select Add New; the value of Number Defined is incremented and the next available number in the Current Definition list sequence is displayed.

Note: If you have deleted definitions prior to the addition, the deleted (missing) numbers in the middle of the Current Definition list sequence are used first before the Utility adds a new number at the end of the sequence.


2. Type your desired message under Text for Line #1 and Text for Line #2 text boxes.


want to associate with the lines. Refer to Setting the Character Attributes for more information.


You can select any of the attributes in this box to associate to each text line except for the Underline 1 Dot and Underline 2 Dot options which are mutually exclusive. This means that both of these options cannot be selected at one time.

Each text line in the definition you create is provided a separate group of character attributes to let you select your desired format in each line. As you select attributes for formatting the text, changes in the text format cannot be viewed in the Utility. You can perform a test print instead using the Test as Bottom Front Message function to view the actual message definition on the receipt.


When you exit from the Reprint on Error Messages window, always remember to select Save All Definitions to save what you have created or modified to the working directory. Refer to Saving All Definitions for further information and instructions.

Note: To save, test print, or delete the current reprint on error message definition, refer to Common Functions in Defining Print Elemfor detailed instruction

ents s.


Note: When you select Test as Bottom Front Message, the message prints as a Bottom Front Message, but when you actually print, the message will be printed as a Reprint on Error Message.


Defining a Page Mode Object This function permits the definition of Printer Page Mode Objects, enabling you to print bitmap images in an orientation other than the standard 0 Degrees, and mix different Print Elements such as text, barcodes and bit images on the same print line. Selecting Page Mode Objects from the Two–Sided Image Definitions 1 screen displays this window:

If no objects are defined yet, only the Create New Object button is available. All the options display their default values. The following shows these values:



Current Object Number 0

Number Defined 0

Logical Origin X 0

Logical Origin Y 0

Length from Logical Origin X 70

Length from Logical Origin Y 248

Element Type Print Line Definitions

Element # Disabled if no definitions exist; otherwise, first definition is displayed.

Distance from Origin X –1

Distance from Origin Y –1

Orientation 0 Degrees (Normal)


If object definitions already exist, Number Defined displays the total number of objects and Current Definition is set to the highest–numbered definition in the list. The rest of the options are appropriately filled in showing the details of that definition.

The actual Maximum X and Maximum Y values depend upon the printer selected. The following table shows these values:

Creating a New Object To create a new object, select Create New Object; Number Defined is incremented and the next available number in the Current Object Number list sequence is displayed.


Note: If you have deleted objects prior to the addition of a new entry, those deleted (missing) numbers in the middle of the Current Object Number list sequence are used first, before a new number is added at the end of the sequence.

Setting the Logical Origin

The Logical Origin designates the starting point, with respect to the 0,0 Physical Origin, of the print area where you can layout and arrange the Print Elements. Perform these steps to set the Logical Origin:

1. Adjust Logical Origin X (horizontal coordinate) by selecting a value within the range of 0–70 in the dropdown list.

2. Adjust Logical Origin Y (vertical coordinate) by selecting a value within the range of 0–248 in the dropdown list next to it.

Note: As values are adjusted, so is the print area in the Simulated Page Mode Object Image.

3. Select Set once you establish the coordinates; the Simulated Page Mode Object Image preview box adjusts according to the set values, turning the space between the physical origin and logical origin to gray.

Note: If you change the Logical Origin or Length from Logical Origin, you probably want to modify the Distance from Logical Origin under the Insert Print Element section.

Example: If you set the Logical Origin to 25 mm X and 75 mm Y, then an area representing 25 mm from the left side of the window and 75 mm from the top of the window turns to gray.


4. Adjust Length from Logical Origin X by selecting a value within the range of 0–70 in the dropdown list.

5. Adjust Length from Logical Origin Y by selecting a value within the range of 0–248 in the dropdown list.

6. Select Set once you establish the coordinates; the Simulated Page Mode Object Image adjusts according to the values you set, turning the space from the maximum coordinates to the Length from Logical Origin coordinates to gray.

Example:

Logical Origin 25 mm X; 75 mm Y

Length from Logical Origin 40 mm X; 125 mm Y

Print Area Coordinates 25 to 65 mm X; 75 to 200 mm Y

Area turned to gray 70 mm (max) – 65 mm = 5 mm from the right hand side of the window

248 mm (max) – 200 mm = 48 mm from the bottom of the window

Inserting Print Elements

Perform these steps to insert Print Elements into the object:


1. Under the Insert Print Element group box, select the Element Type you want to insert. This list provides the following options:

• Print Line Definitions (default)

• Barcodes

• Bit–Images

2. Select a specific definition you have created for the element type chosen in step 1 by selecting the Element #. This dropdown list is disabled if no definitions of the element type exist yet.

Example: If you have 10 Print Line Definitions, the Element # dropdown list should show definitions 1–10.

3. Select Distance from Origin X and Y values. The actual Maximum X and Y values depend upon the printer selected. The following table shows these values:

Printer Model Maximum X Maximum Y

7167 72 mm 250 mm

7197 72 mm 250 mm

7401–K580 72 mm 72 mm

7401–K590 72 mm 250 mm

7432–F306 72 mm 250 mm

7168 72 mm 250 mm

Note: The options for Distance from Origin X and Y must be within the range of –1 to the maximum number of millimeters that fit within the box defined by Logical Origin and Length from Logical Origin. When X or Y is set to –1, this means that the Print Element is printed wherever the cursor is located for that axis. When a valid non–negative value is selected, then the cursor is moved to that location in the page before the element is printed.


4. Select your desired orientation for the Print Element. The point of reference of the rotation is towards the top of the receipt. This function provides the following options:

• 0 Degrees (default)

• 90 Degrees Rotated



Note: As you insert items, a representation of the Print Element displays in the Simulated Page Mode Object Image preview box.


Arranging the Print Elements

The purpose of the Print Elements In Use list box is for you to sort and organize various Print Elements according to your desired arrangement. This box is initially blank indicating that no item has been inserted yet and the Delete button is disabled. In this case, selecting Insert Before or Insert After inserts the first item in the list.


If there is more than one entry in the list, one item is always selected. You can change the selected line by selecting on another entry. The Insert Before, Insert After and Delete all operate based on the currently–selected line. The Print Elements In Use list box uses the following format on each entry in the list: Element Type | Element # | X value | Y value | Orientation

Example: Bit Image 3 15 20 0 Degree Print Line Definitions 2 10 30 0 Degree Print Line Definitions 1 –1 –1 0 Degree

Saving the Page Mode Object Selecting Store Object saves the object in a memory record (object); the Utility automatically places a check mark on the Currently Stored checkbox. If this is a new definition, a new record is created; otherwise, the existing memory record is updated with the changes.

The Currently Stored function only acts as an indicator, whether the current definition is already saved in a memory record or not, which explains why this function is disabled. After saving the Page Mode Object, as soon as you change any settings like changing the Logical Origin, inserting or deleting a Print Element from the list, the Currently Stored check box is unchecked indicating that these updates are not saved.

If Store Entry is not selected, any changes made to the object are lost in three ways:



• When the Page Mode Object window is closed


Test Printing the Object To view the actual appearance of your object definition on the receipt, select the Test button. This function places the printer in single–sided mode and sends the commands that generate the Page Mode Object to the printer and prints it. After the object is successfully printed, the Utility restores the printer to its previous mode.

Deleting the Page Mode Object To delete a Page Mode Object, select Delete Object; Number Defined is decremented. The Utility removes the memory record associated with the object definition and adjusts the values in the Current Object Number list, displaying the details of the next higher number.

If there are no more objects remaining in the list, the Utility displays the same default values as defined when a new object is created. The next time you create another object, the Utility uses the deleted (missing) numbers in the middle of the Current Object Number list sequence first before a new number is added at the end of the sequence.

Note: As soon as you exit from the Page Mode Objects window, always remember to select Save All Definitions to save what you have created or modified to the working directory. Refer to Saving All Definitions for further information and instructions.


Defining a Macro Image All of the other functions within the Utility are done for the purpose of generating the Macro Image Definitions. These are derived using definitions created for the Print Elements and Page Mode Objects. Selecting Macro Image Definitions from the Two–Sided Image Definitions screen displays the following window:


If there are no Macro Images defined yet, you can only Create a New Image. All the options display their default values. The following table displays these values:


Current Image Number 0

Number Defined 0

Object Type Print Line Definitions

Element / Object # Disabled if no definitions exist; otherwise, first definition is displayed.

Currently Stored Checkbox is unchecked.

If macro images already exist, Number Defined displays the total number of objects and Current Image Number is set to the highest–numbered definition in the list. The rest of the options are appropriately filled in showing the details of that definition.

Creating a New Macro Image To create a new macro image, select Create New Image; Number Defined is incremented and the next available number in the Current Image Number list sequence is displayed. The maximum number of images you can create is 25. If you attempt to create more than 25 images, the following error message box displays:


Note: If you have deleted macro images prior to the addition of a new entry, those deleted (missing) numbers in the middle of the Current Image Number list sequence are used first, before a new number is added at the end of the sequence.

Inserting a Print Element or Page Mode Object

To insert a Print Element or Page Mode Object to the macro image, perform the following steps:

1. Select the Object Type you want to insert, of whether it is Print Line Definitions, Barcodes, Bit–Images, or Page Mode Object.

2. Select the Element / Object #; this dropdown list is disabled if no definitions of the object type exist yet.

Note: As you insert items, a representation of the object displays in the Simulated Print Image preview box.


Arranging the Objects

The Print Elements / Page Mode Objects In Use list box permits you to organize different objects according to your desired arrangement. This box is initially blank indicating that no item has been inserted yet and the Delete button is disabled. In this case, selecting Insert Before or Insert After inserts the first item in the list.


If there is more than one entry in the list, one item is always selected. You can change the selected line by selecting on another entry. The Insert Before, Insert After and Delete all operate based on the currently–selected line. The Print Elements / Page Mode Objects In Use list box uses the following format on each entry in the list: Element Type or Page Mode Object | Element # |

Example: Bit Image 3 Page Mode Object 4 Print Line Definitions 2

Saving the Macro Image Definition Selecting Store Entry saves the Macro Image Definition in a memory record (object); the Utility automatically places a check mark on the Currently Stored checkbox. If this is a new definition, a new record is created; otherwise, the existing memory record is updated with the changes.

The Currently Stored function only acts as an indicator, whether the current definition is already saved in a memory record or not, which explains why this function is disabled. After saving the Macro Image Definition, as soon as you change any settings, the Currently Stored check box is unchecked indicating that these updates are not saved.

If Store Entry is not selected, any changes made to the definition are lost in three ways:



• When the Page Mode Object window is closed


Test Printing the Macro Image Definition To view the actual appearance of your Macro Image Definition on the receipt, select the Test button. This function places the printer in two–sided mode and sends the commands to the printer’s RAM. The macro is then defined as the Static Reverse Side Image. The Utility prints the macro on the reverse side of the receipt, and then clears it from the printer’s memory. After the object is successfully printed, the Utility restores the printer to its previous mode.

Deleting a Macro Image Definition To delete a Page Mode Object, select Delete Image; Number Defined is decremented. The Utility removes the memory record associated with the Macro Image Definition and adjusts the values in the Current Image Number list, displaying the details of the next higher number.

If there are no more definitions remaining in the list, the Utility displays the same default values as defined when a new macro image is created. The next time you create another definition, the Utility uses the deleted (missing) numbers in the middle of the Current Image Number list sequence first before a new number is added at the end of the sequence.

Note: As soon as you exit from the Macro Image Definitions window, always remember to select Save All Definitions to save what you have created or modified to the working directory. Refer to Saving All Definitions for further information and instructions.


Data Storage Formats

Overview This section describes how the information defined using the above functions is stored. When you save a definition, the records are stored in memory as sparse array data class. There are different Data Objects for each type of Object. It is recommended to keep each Element Type in a separate sparse array when working with them in memory.

The definitions are written to or loaded from the following files when you select Save All Definitions or Load All Definitions:

Print Object File Type Element Types written to the file

Print Elements

PRTELEMENTS.NCRgcu 01 – Print Line Definitions 02 – Barcode Definitions 03 – Bit Image Filename Associations 04 – Bottom Front Messages 05 – Reverse Side Top Messages 06 – Reprint on Error Message

Page Mode Objects

PRTELEMENTS.NCRgcu 30 – Page Mode Definitions

Macro Image Definitions

PRTELEMENTS.NCRgcu 60 – Macro Image Definitions


Purposes for keeping separate files for each print object:

• Having it in separate files makes integration simpler due to the fact that the Page Mode Objects build upon Print Elements and the Macro Image Definitions build upon both Print Elements and Page Mode Objects.

• It is possible to exchange your definitions for those that are generated by other users.

All Data Objects are built upon records that have the following basic format:

Data Size WORD BYTE WORD Variable Length Bytes

Content Record Length

Element Type being

stored

Element Type Definition #

Data for actual print item definition

Record Length

• Size of the entire record contents in bytes. The Record Length itself is included in the length.

Element Type

• Defines the format of the data. The following are the values for Element Type:

01 – Print Line Definitions 02 – Barcode Definitions 03 – Bit Image Filename Associations 04 – Bottom Front Messages 05 – Reverse Side Top Messages 06 – Reprint on Error Messages 30 – Page Mode Object Definitions 60 – Macro Image Definitions


Definition #

• The identifying index value. It starts at 0 for each Element Type up to a maximum value of 65535. In all cases except for the Bit Image Filename Association, this index is the number displayed on the User Input screen. In the case of the Bit Image, this index is an internal tracking number not shown to the user.

Note: Maximum value for element types 04 (Bottom Front Messages), 05 (Reverse Side Top Messages), and 06 (Reprint on Error Messages) is on127, not 65535. Range for element type 60 (Macro Image Definitions) is only 1 to 25.

ly

Data

• A variable length field that contains the bytes defining the information stored.

Print Line Definition The Print Line Definition has several fields. The print data field is broken up into several recursive sub–fields. The record format of a Print Line definition is as follows:

Data Size BYTE BYTE BYTE WORD Variable Length BYTES

Content Font Size Alignment Rotation VLI Attribute

Marker Text Field

Attribute Marker

Text Field

Font Size

• The value indicating if a 44– or 56–character font is used for all text associated with this record:

01 – Normal (44 characters) 02 – Compressed (56 characters)


Alignment

• Indicates how all text defined in the record is aligned on the receipt:

01 – Left 02 – Center 03 – Right

Rotation

• Defines the orientation of the text with respect to the receipt. If a 90–degree left or right rotation is defined, then all text data is reformatted into rotated lines before it is sent to the printer.

Example: If you have 5 lines and a 90–degree right rotation is defined, then the first character of each of the 5 lines are assembled together to form the first print line. The second character of each line is assembled together to from the second print line. If a line runs out of characters, spaces are inserted. Only the first Attribute Marker is used when a rotation other than 0 or 180 is defined. All other Attribute Markers after the first one are ignored if rotation of 90 or 270 is defined.

Its value is one of the following:

01 – 0 Degrees (normal) 02 – 90 Degrees (rotated right) 03 – 180 Degrees (upside down) 04 – 270 Degrees (rotated left)

VLI

• Variable length indicator specifying the total bytes of both Text and Attribute Marker fields.


Attribute Marker

• Defines how the text following the marker is displayed when printed. There can be several Attribute Markers within a text field. An Attribute Marker is inserted anytime you want to change the characteristics of the printed text. The following defines the data fields of an Attribute Marker:

Data Size BYTE BYTE BYTE BYTE WORD

Content Attribute Marker

Character

Character Size

Vertical Scaling

Horizontal Scaling

Attribute Bit Mask

Attribute Marker Character

• A Hex value of 0x1F is inserted in the text data every time the user selects Insert Attribute Marker option in the Utility.

Character Size

• Indicates any special sizing of the characters:

01 – Normal (no special sizing) 02 – Double High 03 – Double Wide 04 – Double High and Double Wide 05 – Scaled by Values in the Vertical and Horizontal Scaling Bytes

Vertical Scaling

• This is only used if value of Character Size is 05 (Scaled by Values). Possible value is from 1 to 8. Default value is 1.

Horizontal Scaling

• This is only used if value of Character Size is 05 (Scaled by Values). Possible value is from 1 to 8. Default value is 1.


Attribute Bit Mask

• A single byte that defines other print characteristics associated with the text data following the attribute marker:

Bit 0 – BOLD Bit 1 – ITALIC Bit 2 – Super Script Bit 3 – Sub Script (Bit 2 and 3 are Mutually Exclusive if either one is set) Bit 4 – 1 Dot Underline Bit 5 – 2 Dot Underline (Bit 4 and 5 are Mutually Exclusive if either one is set) Bit 6 – Reverse Video (white characters on black background) Bit 7 – Alternate Color

Text Field

• Consists of any ASCII printable characters and a Line Feed (LF) inserted when the user indicates a new line through Utility input. It can contain a Variable Text Marker, which should look like the field below:

Text Field Variable Text Marker Text Field

Each Variable Text Marker consists of several bytes of information. This information defines the variable data that the application defines, which is inserted at the location of the Variable Text Marker.

Data Size BYTE BYTE BYTE

Content Variable Text Marker Variable ID Maximum Characters


Variable Text Marker

• Has a value of 0x1E indicating that the next two bytes are a part of a Variable Text Marker.

Variable ID

• The identification decimal value from 1 to 50 indicating the variable to print.

Maximum Characters

• A decimal value from 1 to 57 indicating the maximum number of characters to display for testing.

Barcode Definition The following format defines the data fields for a Barcode Print Element:

Data Size BYTE BYTE BYTE BYTE BYTE BYTE BYTE WORD Variable

BYTES

Content Alignment Rotation HRI

Size HRI POS Height Width Symbology VLI Barcode

Data

Alignment

• Defines how the barcode is aligned on the receipt:


Rotation

• Defines the orientation of the barcode with respect to the receipt:


01 – 0 Degrees 02 – 90 Degrees 03 – 180 Degrees 04 – 270 Degrees

HRI Size

• Size of the Human Readable Interpretation (HRI) characters used when printing it:

01 – 15.2 characters per inch (CPI) Font 02 – 19 characters per inch (CPI) Font

HRI POS

• Position for printing the Human Readable Interpretation with respect to the barcode:

01 – HRI is not printed 02 – HRI is printed below the barcode 03 – HRI is printed above the barcode 04 – HRI is printed both above and below the barcode

Height

• Height of the barcode in dots. Possible values are from 1 to 255 (decimal).

Width

• Integral width number for the bars on the barcode. Possible values are from 1 to 5 (decimal).

Symbology

• Barcode system of bar generation used for creating the barcode:


01 – UPC–A 02 – UPC–E 03 – JAN13 (EAN13) 04 – JAN8 (EAN8) 05 – Code 39 06 – Interleaved 2 of 5 07 – CODABAR 08 – PDF417 09 – Code 93 10 – Code 128

VLI

• Variable length indicator containing the number of bytes of the Barcode Data field.

Barcode Data

• ASCII characters of information printed in the barcode. Format is dependent upon the Symbology chosen.

Bit Image Filename Association The following record format stores the Bitmap Image Associations used for the Macro Image Definition:

Data Size BYTE BYTE WORD Variable BYTES

Content Alignment Logo Position VLI Path and Filename

Alignment

• Position of the Bitmap on the receipt:



Logo Position

• Defines the Logo number in the printer’s memory assigned to this Bit Image when loaded into the printer. So as not to interfere with values assigned by OPOS, the possible image numbers are from 30 to 255.

VLI

• Variable length indicator containing the number of bytes of the Path and Filename field.

Path and Filename

• Refers to the path and filename where the image is stored on disk. The image must be one of the images saved from the Graphics portion of the Utility. These files are Windows BMP but have an extension of .NCRImage so they can easily be identified. At the time of creating the Macro Image Definition, the image file is converted to a Binary load for the printer.

Reverse Side Top Message The data fields of a reverse side top message are very similar to those of a Print Line definition. It always consists of the following information, although some of the fields may contain NULLs. The following describes the data fields:

Data Size 6 BYTES WORD Variable

BYTES 6 BYTES WORD Variable BYTES

Content Attribute Marker VLI Text Data Attribute Marker VLI Text Data

Text Data

• Consists of ASCII characters. If no data is defined for the text field, it contains a single NULL byte.


VLI

• Variable length indicator that contains the number of bytes of the text that follows.

Attribute Marker

• A Hex value of 0x1F is inserted in the text data every time the user selects Insert Attribute Marker in the Utility. This is similar to the Attribute Marker used in the Print Line definition, only some of the fields are defined NULL. The fields are kept to permit usage of the same parsing code with minor conditionals added for handling the differences. Its record format is defined as follows:

Data Size BYTE BYTE BYTE BYTE BYTE WORD

Content Attribute Marker

Character

Marker Index

Character Size

Vertical Scaling

Horizontal Scaling

Attribute Bit Mask

Attribute Marker Character

• A Hex value of 0x1F is inserted in the text data every time the user selects Insert Attribute Marker in the Utility.

Marker Index

• Designates the location of the Attribute Marker:

01 – First attribute marker for top line message 02 – Second attribute marker for bottom line message

Character Size

• Indicates any special sizing for the characters:


01 – Normal (no special sizing) 02 – Double High 03 – Double Wide 04 – Double High and Double Wide 05 – Reserved (Scaling is not an option for Top/Bottom Messages)

Vertical Scaling

• Contains a NULL value when unused.

Horizontal Scaling

• Contains a NULL value when unused.

Attribute Bit Mask

• A single byte that defines other print characteristics associated with the text data following the attribute marker:

Bit 0 – BOLD Bit 1 – ITALIC Bit 2 – Reserved (not valid for Top/Bottom Messages) Bit 3 – Reserved (not valid for Top/Bottom Messages) Bit 4 – 1 Dot Underline Bit 5 – Reserved (not valid for Top/Bottom Messages) Bit 6 – Reverse Video (white characters on black background) Bit 7 – Reserved

Bottom Front Message The format for the Bottom Front Message record is identical to that of the Reverse Side Top Message. The only difference is the Element Type number that identifies the overall record type (refer to the Overview section for more information about the Element Types). The Element Type value for Bottom Front Message is 04 whereas Reverse Side Top Message is 05.


Note: Refer to Reverse Side Top Message section for the specific record format of Bottom Front Message.

Reprint on Error Message The format for the Reprint on Error Message record is identical to that of the Reverse Side Top Message. The only difference is the Element Type number that identifies the overall record type (refer to the Overview section for more information about the Element Types). The Element Type value for Reprint on Error Message is 06 whereas Reverse Side Top Message is 05.

Note: Refer to Reverse Side Top Message section for the specific record format of Reprint on Error Message.

Page Mode Object The following is the record format for a Page Mode Object:

Data Size BYTE BYTE BYTE BYTE BYTE WORD Variable

BYTES

Content Origin X Origin Y Width X Width Y Total

Elements VLI Page Object Elements

Origin X

• Start of print area in millimeters in the X (horizontal) direction with respect to the 0,0 physical origin.

Origin Y

• Start of print area in millimeters in the Y (vertical) direction with respect to the 0,0 physical origin.


Width X

• Length in millimeters in the X (horizontal) direction from the logical origin of the print area.

Width Y

• Length in millimeters in the Y (vertical) direction from the logical origin of the print area.

Total Elements

• Total number of Print Elements in the Page Mode definition.

VLI

• Variable length indicator that contains the total number of bytes of the Page Object Elements field.

Page Object Elements

• There are 5 bytes that define each of the Print Element objects used in the Page Mode definition. So the total number of bytes is equal to Total Elements multiplied by 5 bytes. The following defines the data fields of each Page Object Element:

Data Size BYTE WORD WORD WORD BYTE

Content Element Type Definition # Origin X Origin Y Rotation

Element Type

• Print Element Type number which is one of the following:

01 – Print Line Definition 02 – Barcode Definition 03 – Bit Image Definition


Definition #

• Identification number of the Print Element listed under a Print Element type.

Origin X

• Offset relative to the physical origin to place the print object

–1 = Use current cursor position Range of values: 1mm to maximum physical length

Origin Y

• Offset relative to the physical origin to place the print object

–1 = Use current cursor position Range of values: 1mm to maximum physical length

Rotation

• Defines the orientation of the Print Element from the origin:

01 – 0 Degrees 02 – 90 Degrees 03 – 180 Degrees 04 – 270 Degrees

Macro Image Definition The following are the data fields for the Macro Image Definition:

Data Size BYTE WORD Variable BYTES

Content Number of Reverse Side Objects VLI Reverse Side Print

Objects

Number of Reverse Side Elements

• Total number of reverse side print objects.


VLI

• Variable length indicator that contains the number of bytes used by the Reverse Side Print Objects field.

Reverse Side Print Objects

• Each object consists of 2 bytes, Object Type and Definition Number, that define the actual appearance of the back side of the receipt. Its data fields are as follows:

Data Size BYTE WORD

Content Object (Element) Type Definition Number

Object (Element) Type

• A Print Element or Page Mode Object printed on the reverse side of the receipt. It could be one of the following:

01 – Print Line Definition 02 – Barcode Definition 03 – Bit Image Filename Association 30 – Page Mode Definition

Definition Number

• Identification number of the Object listed under an object (element) type. Range of values is from 1 to 65535.


Printer Escape Sequences This section defines the conversion of data inputted and defined from the Utility, which is stored into Data Storage Formats (refer to Data Storage Formats section), into actual printer text data and commands for creating the Macro Image Definitions. This also includes data sent to the printer when clicking the Test button from the Utility to test print the objects defined.

The command sequences sent to the printer are defined for each Print Element type. For Page Mode and Macro Image Definition objects, only commands unique to these objects are defined. It is imperative that you refer back to the information of the individual Print Elements that make up those unique commands, as there are additional data required to be sent out with Page Mode and Macro Image Definition objects.

Print Line Definition Each print line definition starts with the setting of its Font Size, Alignment and Rotation. These settings affect how the remainder of the information is processed.

Font Size Escape Sequence: 1B 21 n

Bit 0 = 0 – 44 columns (Normal) 1 – 56 columns (Compressed)

The remaining bits 1–7 are set based on the attribute marker. This escape sequence is not sent until these attributes that are also set by this command are determined. If an attribute marker changes these values, the value Bit 0 needs to be preserved and should not change.


Alignment Escape Sequence: 1B 61 n, where n is the alignment parameter. The following shows the possible values of n:

n = 0 – Left Aligned 1 – Center Aligned 2 – Right Aligned

Rotation Escape Sequence: A combination of the 90–degree and 180–degree rotate commands. For a 270–degree rotation, both of these commands are set. The following designates the pair of escape sequences for each rotation command:

0 Degrees 1B 56 0 (90 1B 7B 0 (180 Reset) 90 Degrees 1B 56 1 (90 Set) 1B 7B 0 (180 Reset) 180 1B 56 0 (90 1B 7B 1 (180 Set) 270 1B 56 1 (90 Set) 1B 7B 1 (180 Set)

There is a special consideration that you need to take for the 90–degree and 270–degree rotation. When these are selected, the Utility rearranges the text data to form the 90–degree or 270–degree rotated lines. For the 90–degree rotation, the first characters of each line in the text block are combined to form the first physical line. The second characters of each line form the second physical line and so on and so forth. If a line does not have enough character, spaces are inserted to fill out the line. Alternatively for the 270–degree rotation, the last characters of each line are joined to form the first physical line. The second–to–the–last characters of each line become the second physical line, working its way backwards.


Attribute Marker Each print line definition contains at least one attribute marker. The following table shows the command sequences inserted into the text data each time an attribute marker is encountered, to set the selected attributes at the printer.

Attribute Printer Escape Sequence

Character Size 1B 21 n

Bit 4 = 0 – Normal 1 – Double High

Bit 5 = 0 – Normal 1 – Double Wide

Scaling Horizontal & Vertical

1D 21 n

Each nibble represents BCD scaling upper 0–7 Width 1, 2 and so forth times. Lower 0–7 Height 1, 2, etc times. Double High and Double Wide = 11.

Bold 1B 21 n

Bit 3 = 0 – Normal 1 – Bold

Italic 1B 49 n

n = 0 – Normal 1 – Italic

SuperScript / SubScript

1F 05 n

n = 0 – Normal 1 – SubScript 2 – SuperScript


Attribute Printer Escape Sequence

1 Dot Underline / 2 Dot Underline

1C 2D n

n = 0 – No underline 1 – Single Dot Underline 2 – Double Dot Underline

Reverse Video (White characters on black background)

1D 42 n

n = 0 – Normal 1 – Reverse Video

Variable Text Marker When a Variable Text Marker is encountered in the text data, the Utility replaces the marker by a three–byte command to print the text variable.

Escape Sequence: 1F 70 n, where n = 1–50 (decimal) and is the contents of the Variable ID byte.

Barcode Definition Each barcode definition begins with commands that set the barcode’s alignment, rotation, width, height, HRI size, HRI position. Finally, the Utility sends the command to actually print the barcode.

Option Printer Escape Sequence

Alignment 1B 61 n, where n is the alignment parameter.


Rotation This is a combination of the 90–degree and 180–degree rotate commands. For 270–degree rotation, both commands are set.



0 Degrees 1B 56 0 (90 Reset) 1B 7B 0 (180 Reset) 90 Degrees 1B 56 1 (90 Set) 1B 7B 0 (180 Reset) 180 Degrees 1B 56 0 (90 Reset) 1B 7B 1 (180 Set) 270 Degrees 1B 56 1 (90 Set) 1B 7B 1 (180 Set)

HRI Size 1D 66 n

n = 0 – Standard Pitch (15.2 CPI) 1 – Compressed Pitch (19 CPI)

HRI POS 1D 48 n

n = 0 – No HRI printed 1 – HRI is printed above the barcode 2 – HRI is printed below the barcode 3 – HRI is printed both above and below the barcode

Height 1D 68 n, where n = 1–255 (decimal) barcode height value as selected in the Utility.

Width 1D 77 n, where n = 1–5 (decimal) integral width value as selected in the Utility.

Print Barcode

1D 6B m n d1…dn

m = Barcode Symbology = 65 – UPC–A 66 – UPC–E 67 – JAN13 68 – JAN8 69 – CODE 39 70 – Interleaved 2 of 5 71 – CODABAR 72 – CODE 93 73 – CODE 128 75 – PDF 417

n = Length of actual barcode data



d1…dn = Actual numeric or alphanumeric data to generate the barcode

Bit Image Filename Association The Bitmap Image must be an image loaded and saved using the Image feature of the Utility. The Utility uses the codes from the Image feature to send and load these bitmap images into the printer. The commands used to print the bit image filename association are transmitted along with the Macro Image Definition commands. Therefore, the Utility separately sends the loading commands from the printing commands of the bitmap image filename association. The following table lists the print commands of the bit image filename association:


Alignment 1B 61 n, where n is the alignment parameter.


Print Bit Image with Logo Position

1D 2F n, where n is the Logo Position from 30–255.


Reverse Side Top Message The Utility sends the Reverse Side Top Message commands only if the user defines a new message or prevents the current message to be printed. No commands are sent if the user wants to keep the current message. The following commands define how to change or delete each line of the reverse side top message:

Line 1 Escape Sequence: 1F 65 2 k d1…dn NULL

Line 2 Escape Sequence: 1F 65 3 k d1…dn NULL, where

k = Attributes defined for each line

Bit Position Attribute Mode

Bit 0

Bit 1

00 – Underline Mode OFF 01 – 1 Dot Underline 10 – 2 Dot Underline

Bit 2 Double High (Set), Single High (Reset)

Bit 3 Double Wide (Set), Single Wide (Reset)

Bit 4 Emphasize Mode/Bold ON (Set), OFF (Reset)

Bit 5 Alternate Color (Set), Black (Reset)

Bit 6 Reverse Video/White Characters on Black (Set), Black Characters on White (Reset)

Bit 7 Italic (Set), Normal (Reset)

d1…dn = Text data of the message definition terminated by the NULL character. If only a NULL is defined, then the previous message is erased.


Bottom Front Message The Utility sends the commands for Bottom Front Message if the user defines a new message or prevents the current message to be printed. The Utility does not send any command if the user wants to keep current message. The following commands define how to change or delete each line of the bottom front message:





Bit 0

Bit 1










Reprint on Error Message The Utility sends the Reprint on Error Message commands only if the user defines a new message or prevents the current message to be printed. No commands are sent if the user wants to keep the current message. The following commands define how to change or delete each line of the reprint on error message:





Bit 0

Bit 1










Page Mode Object The Page Mode Object consists of a few Page Mode commands followed by sending out the commands for the Print Elements used within the Page Mode Object. For purposes of calculation, it is assumed that the default Horizontal and Vertical Minimum Motion Units are used. It would be very rare for someone to actually change them.

The default x and y minimum motion units are 1/203 of an inch, or 1/8 of a millimeter. For any measurements given in millimeters, the calculation to change them from millimeters to minimum motion units is as follows:

Minimum Motion Units (MMU) = Millimeters*8

The Minimum Motion Units then have to be converted into a 2–byte representation with the low byte first.

MMU/256 = High Byte

MMU MOD 256 = Low Byte

Example: The maximum printable size in the X direction is 72mm.

72mm (dx)*8 MMU/mm = 576

576/256 = 2 (n2)

576 MOD 256 = 64 (n1)

This is the default value for the Page Mode Print Area Length and Width. Any time a millimeter position x0, y0, dx, yx needs to be converted into an n1, n2 you perform the above calculation.

Start of Page Mode Object Commands The following defines the start of the sequence of commands when sending a Page Mode Object to the printer:

1. The first thing done is to send the command to Enter Page Mode.

Enter Page Mode: 1B 4C


2. The second operation is to define the print area. This is done using the Origin X, Origin Y, Width X, and Width Y from the Page Mode data. The above formula is used to turn these into the n1 to n8 parameters of the printer command.

Origin X: Converted into n1, n2 Origin Y: Converted into n3, n4 Width X: Converted into n5, n6 Width Y: Converted into n7, n8

Printer Escape Sequence: 1B 57 n1, n2, n3, n4, n5, n6, n7, n8

Page Mode Element Object Commands The next set of commands sent to the printer depends on the attributes of the individual Page Mode Elements. The following shows the corresponding escape sequences for each attribute:

Set Print Direction On the very first element, you need to set the print direction in Page Mode based on the Rotation byte. On the processing of subsequent Page Mode Elements, the print direction is only be sent out if the Rotation byte has a different value than the previous one. The following is the Select Print Direction in Page Mode sent to the printer when needed.

Printer Escape Sequence: 1B 54 n where n = One of the following values based on the Rotation byte. The starting print location is defined by the virtual upper left corner of the page as defined by the Rotation value.

Rotation: 01 – 0 Degrees n = 0x00 Rotation: 02 – 90 Degrees n = 0x03 Rotation: 03 – 180 Degrees n = 0x02 Rotation: 04 – 270 Degrees n = 0x01

The next thing to do is to set the relative X and Y positions as defined by the Page Mode Element.


Set Relative Y Position If Origin Y is a –1 then no position is sent to the printer. The current cursor position is used and no command is sent to the printer. If the value is anything other than –1 it is converted into an n1 and an n2 value based on the conversion method at the top of the section. And the following is the command sent to the printer.

Printer Escape Sequence: 1D 24 n1 n2

Set Relative X Position If the Origin X is a –1 then no position is sent to the printer. The current cursor position is used and no command is sent to the printer. If the value is anything other than –1 it is converted into an n1 and an n2 value based on the conversion method at the top of the section. And the following is the command sent to the printer.

Printer Escape Sequence: 1B 24 n1 n2 At this point you are now ready to send out the Print Element information based on the Print Element Type and Definition # pointed to by the Element Type and Definition # in the Page Mode Element data.

The Element Types can be:

01: Print Line

02: Barcode

03: Bit Image

Note: In the case of a Print Line, the Set Relative X Position command is sent out between each line defined.

Repeat sending out all of the commands as describe previously for each Page Mode Element Object in the Page Mode Object definition.


End Page Mode For each Page Mode Object, after all of the elements are sent, then you must issue the command to print the page and exit and return to standard mode.

Print and Return to Standard Mode: 0C

Image Macro Definition Before generating any Image Macro definition, the Print Element Objects that make up this Image Macro definition need to be searched for Bit Image Filename Associations. The Bit Image definition commands from the Graphics portion of the utility for any Bit Images used need to be sent to the printer, or written to the Binary file before the Image Macro definition commands.

This describes the commands used to output the entire Image Macro definition. The Image Macro definition consists of a few commands that encapsulate the Page Mode Objects and Print Elements that are embedded within the Image Macro Definition commands.

These encapsulating commands consist of a Macro definition number, and a few Two–Sided Thermal commands. The Reverse Side Image is defined as a Macro for later printing, or activation as Reverse Side Image. The sequence of commands is as follows:

1. First send command to make sure the Image Macro Definition is stored in Flash.

Printer Escape Sequence: 1D 22 35 2. Next send down the command to select the macro for the Image

Macro Definition # which is defined 1–25.

Printer Escape Sequence: 1F 67 n where n is 1 – 25

3. Send down the command to start Macro Definition

Printer Escape Sequence: 1D 3A


4. Next send down all of the Print Element Objects that are defined for this Image Macro Definition #. To do this, send down the commands as defined previously for each of the Reverse Side Print Objects that are defined.

01: Print Line Definition

02: Barcode Definition

03: Bit Image Filename Association

30: Page Mode Definition

5. After all of this data has been sent to the printer, then you end the Macro Definition by sending the command.

Printer Escape Sequence: 1D 3A


Set Macro Options The following details the extra commands needed for sending out the Macro Options that are defined by the Set Macro Options dialog box which is presented to the user when they select the Make Macros Binary File, Download Macros to Printer, or Set Macro Options. These Macro Option commands should be sent to the printer or written to the binary file prior to the Image Macro definitions themselves. In the case where the Set Macro Options is selected, only these commands are sent to the printer. They are not followed by Image Macro definition commands.


The commands to send down will depend on the operations that are checked to be performed:

If Erase Previous Macros is selected, then the command 1D 40 31 is sent to the printer. It must wait for a CR response byte to know the erase has completed.

If Activate Macro as Reverse Side Image is checked, then the following commands need to be sent out to the printer, or written to the binary file:

1F 68 1F 68—Clears Pre–Defined Back Side Printing

1F 68—Starts Pre–Defined Back Side Printing

1F 67 n—Selects the Macro where n should be the Macro number from the Drop Down menu of the Set Macro Option dialog within the range of 1–25 (decimal).

1D 5E 1 0 0—Executes the Macro

1F 68—End Pre–Defined Back Side Printing

If the Set Reverse Side Orientation is checked, either of the following commands is sent to the printer or written to the binary file:

1F 11 61 00 FF—01: 0 Degree (Normal)

1F 11 61 02 FF—02: 180 Degree (Upside Down)

If Set / Erase Top Bottom Receipt Message is checked, then the commands for either setting or erasing the pre–defined Bottom Front Message and Reverse Side Top Message are sent out based on the definition number specified in the drop box of the dialog. Refer to Bottom Front Message and Reverse Side Top Message sections for the specific commands.

If Enable/Disable Top Bottom Reprint Message is checked, then the commands to either enable or disable the Bottom Front Message, Reverse Top Message, Reprint on Error Message, and Reprint Message Funcationality.


Miscellaneous Two–Sided Thermal Commands There are some commands needed to communicate with the printer by the Utility that do not fall under a specific operation. These commands are the ones to read and set the current two–sided mode.

Each dialog where a Print Element, Page Mode Object, Image Macro and so forth is defined has a Test button that permits the user to immediately print what they have defined. When each definition talks about the specific mode into which the printer is placed for executing the Test, the following commands are needed to read the existing mode of the printer, set it to the mode required for the test, and restore it to the mode it was in before the test.

Real–Time Command to Obtain Current Two–Sided Print Mode The following is the Read–Time command for obtaining the current two–sided Mode of the printer. A single byte response is sent after the command is processed.

Printer Escape Sequence: 1F 73 01 Response single byte is defined as follows:

Bit Off/On Hex Decimal Function

1, 0 – 00 0 Single Sided Mode

– 01 1 Double Sided Mode with Single Command

– 10 2 Double Sided Mode with Double Command

– 11 3 Double Sided Mode with Predefined Backside

2 – 0 0 Not defined. Fixed at 0.


Bit Off/On Hex Decimal Function

3 Off 00 0 Front Side selected (valid only in Double Side Mode with Double Command)

On 08 8 Back Side selected (valid only in Double Side Mode with Double Command)





Command to Set Current Two–Sided Print Mode The command for setting the current two–sided mode of the printer is as follows:

Printer Escape Sequence: 1F 11 60 n where n = Mode setting: 00: Single Sided Mode

01: Double Sided Mode with Single Side command

02: Double Sided Mode with Double Side command

03: Double Sided Mode with Pre–Defined data

release 2.0 user guide - ncr corporation · 1 chapter 1: overview introduction the ncr print...

Documents