Table of Contents
Advertisement
Quick Links
O'Neil Programming
Language Reference Manual
The most reliable portable printers available for distribution,
retail, manufacturing, law enforcement, utilities, transportation,
and an extensive range of business services.
"
We've earned our reputation
by building and supporting the
most reliable portable printers
in the industry. O'Neil printers
are engineered with one goal
in mind: to keep on working...
"
and they do!
Advertisement
Chapters
Table of Contents
Subscribe to Our Youtube Channel
Related Manuals for Oneil microFlash2
Summary of Contents for Oneil microFlash2
- Page 1 O’Neil Programming Language Reference Manual “ We’ve earned our reputation by building and supporting the most reliable portable printers in the industry. O’Neil printers are engineered with one goal in mind: to keep on working… ” and they do! The most reliable portable printers available for distribution, retail, manufacturing, law enforcement, utilities, transportation, and an extensive range of business services.
- Page 2 O’Neil Product Development, Inc. 8 Mason Irvine, CA 92618 Tel: (949) 458-0500 Fax: (949) 458-0708 www.oneilprinters.com Copyright © 2006 O’Neil Product Development, Inc. All rights reserved. This manual and any examples contained herein are provided ‘as is’ and are subject to change without notice.
-
Page 4: Table Of Contents
Table of Contents Introduction Overview of Printing Modes Line Printer Mode Easy Print Mode Using This Guide Document Conventions Graphic Conventions Using Line Printer Mode Overview of Line Printer Mode Line Printer Commands Using Easy Print Mode Overview Easy Print Commands: General Guidelines Sample Easy Print Job Easy Print Commands Ahead Command... - Page 5 Table of contents (continued) Querying the Printer Overview Sending Queries Interpreting Query Replies Query Formats Query Commands Status Query Status Reply Explanation Print Job Status Query Print Job Status Reply Explanation Configuration Query Configuration Reply Explanation Battery Query Version Query Version Reply Explanation Memory Query Memory Reply Explanation...
-
Page 6: Introduction
Introduction The O'Neil Quick Reference Programmer's Guide is a reference guide for O'Neil printers. This programming guide documents the functions and features of the printer's programming language. Note: The commands documented in this programmer's guide are available depending upon which version of firmware is installed on your printer and which printer you are using. -
Page 7: Using This Guide
Introduction TO PRINT LINE PRINTER EASY PRINT EMULATION Bar Codes Complex image (exact text/barcode/graphic positioning important) Line after line of text (receipts or invoice) Graphics (one time – not stored) including captured signatures Graphics (stored) Labels (Butt cut or Die Cut) with alignment “Q” X (Text Only) X (Complex) mark or gap between labels... -
Page 8: Graphic Conventions
Introduction Graphic Conventions Use the following information Note: The note symbol is followed by additional information about a topic. Caution: The caution symbol is followed by information that can help you avoid costly mistakes. O’Neil Programming Language Reference Manual... -
Page 9: Using Line Printer Mode
Using Line Printer Mode Overview Line printer mode is the simplest protocol supported by the O'Neil thermal printers. Using Line Printer mode, you can send a line of text as a sequence of characters to the printer followed by a carriage return (0x0D), and/or a line feed (0x0A), or a form feed (0x0C) and the printer prints that line of text. - Page 10 Chapter 2: Using Line Printer Mode ESC Hn Multiplies the height n times ESC Q n1n2 Advances n1n2 from the Q mark. For more information about the Q mark, refer to Specifications in the O'Neil Thermal Programming Guide. ESC R n International font selection ESC ! n Sets double wide and double high...
- Page 11 Use the following table for guidelines when adding a bit- mapped graphic. Printer Type Dots Bytes Dots Per Inch Across Across microFlash2 microFlash3 microFlash4t/4tCR microFlash2t/2tCR microFlash2i/2iCR 127 Horizontal 69 Vertical O’Neil Programming Language Reference Manual...
- Page 12 Note: The microFlash3 printer has 576 bits across a single line; the microFlash2/2t has 384 bits and the microFlash2i has 240 bits microFlash4t has 832 bits across a single line. Set Double Wide Print...
- Page 13 Chapter 2: Using Line Printer Mode Form Feed Format Function Prints the current line, then advances the paper to top of form (TOF). Line Feed Format Function Prints the current line and advances the paper. Carriage Return Format Function Prints the current line and advances the paper to top of form (TOF).
- Page 14 Chapter 2: Using Line Printer Mode Note: Use the following Easy Print command to return to Line Printer mode while in Easy Print mode. {LP} is not a Line Printer command. If you mistakenly use {LP} while in Line Printer mode, {LP} prints on your receipt or label.
- Page 15 Chapter 2: Using Line Printer Mode ESC EZ Go to Easy Print Mode Format ESC EZ Function Puts the printer in Easy Print Mode. You must use uppercase letters EZ. O’Neil Programming Language Reference Manual...
-
Page 16: Using Easy Print Mode
Using Easy Print Mode Overview The Easy Print protocol is much more than just a printing protocol. In its most basic form, Easy Print mode allows the user to send and execute commands. As part of the command execution, the printer may return data to the host. In addition to printing, commands also allow paper motion, configuring, and control of peripherals such as the magnetic and smart card readers. - Page 17 Chapter 3: Using Easy Print Mode ORIGINAL RADIO READY COMMAND MEANING MF2/MF3/2t/4t 2t/3l/4t PAPER MOVEMENT AHEAD:nnn Advances paper by nnn dotlines BACK:nnn Retracts paper by nnn dotlines Status (returns a fixed status string) SWITCH PROTOCOLS Puts printer into configured default protocol Puts printer into Line Printer mode Synonym for LP...
-
Page 18: Easy Print Commands: General Guidelines
Chapter 3: Using Easy Print Mode Note 1: This chapter assumes a basic knowledge of computer programming and is designed to be used by programmers, software engineers, and technicians. Note 2: To switch between Easy Print and Line Printer modes, enter ESC EZ to go to Easy Print mode. -
Page 19: Easy Print Commands
Chapter 3: Using Easy Print Mode Easy Print Commands Easy Print commands have a unique format and function. All but the Query class of commands are documented on the following pages. For information on queries, refer to Querying the Printer in the O'Neil Thermal Programming Guide. Note: In this chapter, an n indicates ASCII numbers, not binary numbers. -
Page 20: Line Printer Mode
Chapter 3: Using Easy Print Mode Line Printer Mode Line Printer Mode {LP} A left bracket begins the command set. LP puts the printer into Line Printer mode. Note: Do not send additional characters for 500ms (is this the time period?) after sending this command (need more info. -
Page 21: Easy Print: Using The Print Command
Chapter 3: Using Easy Print Mode Easy Print: Using the Print Command In Easy Print mode, the Print command includes all possible printer actions used to stop the paper, rotate images, print images, and alter images. Use the following format for Print commands: {Print, Global Options:@row,col:Name,Field Options|data|} A left bracket ({) begins the print command set. -
Page 22: Print Command: Guidelines
Chapter 3: Using Easy Print Mode Print Command: Guidelines • Use the correct terms for global and field options (for example, QSTOPn or WIDEn where n indicates a number in the range). If a global or field option is entered incorrectly, the print request is rejected. - Page 23 Chapter 3: Using Easy Print Mode STOPnnn Stop Global Option Format STOPnnn (1<nnn<65000) Function Advances the paper to the proper point for tearing. This option stops the paper nnn dotlines (.005”/dotline or 200 dotlines/inch) after the beginning of the label or receipt. The data nnn is sent after the STOP option specifies the total number of dotlines high for the image.
-
Page 24: Print Command: Customizing Fonts
Chapter 3: Using Easy Print Mode Print Command: Customizing Fonts Font Names {Print, Global Options:@row,column:NAME,Field Options|data|} Use the following options to customize fonts. Each font has a five-character name. The following is a partial list of font names. For a list of all available fonts, refer to the O'Neil Portable Printers Fonts Guide or call your O'Neil representative at (949) 458-0500. -
Page 25: Print Command: Customizing Bar Codes
Chapter 3: Using Easy Print Mode Print Command: Customizing Bar Codes Bar Code Names {Print, Global Options:@row,column:NAME,Field Options|data|} Use the following options to customize a bar code: Name Description Requirements for Data BC39N Code 39 Use the following characters in the data field: 2:1 ratio Space $ % + . -
Page 26: Using Pdf-417 Symbols
Chapter 3: Using Easy Print Mode Using PDF-417 Symbols You can print any characters using O'Neil PDF-417 symbols. PDF-417 symbols are optimized for printing a mixture of numbers, text, and control characters. To use PDF-417 as a standard bar code: Enter Easy Print Mode using ESC+EZ. -
Page 27: Print Command: Customizing Graphic Names
Chapter 3: Using Easy Print Mode Print Command: Customizing Graphic Names Graphic Names {Print, Global Options:@row,column:NAME,Field Options|data|} Function Prints a stored graphic. Example 1 {PRINT:@10,30:ALOGO|} Prints the logo stored under the five-character name (ALOGO), or a single character name. (See Chapter 3 on how to use the Graphics button in the microFlash configuration program to automatically store a graphic.) Example 2... -
Page 28: Easy Print: Using Configuration Commands
Chapter 3: Using Easy Print Mode Easy Print: Using Configuration Commands Configuration commands are either in two-letter or three-letter formats. One or several two letter commands can be sent to the printer but are not written to Flash memory and do not take effect until a {COMMIT} command is sent. - Page 29 Chapter 3: Using Easy Print Mode Configure Baud Rate {CB:nn} Original Radio Ready MF2, MF3, 2t, 4t 2t, 3l, 4t A left bracket begins the command set. CB:nn Configures the baud rate. Use the following values to specify the baud rate: X (MF2/MF3) nn=00: 1200 BAUD nn=01: 2400 BAUD...
- Page 30 Chapter 3: Using Easy Print Mode Form Feed Active {CF:n} Original Radio Ready MF2, MF3, 2t, 4t 2t, 3l, 4t A left bracket begins the command set. CF:n n= y or Y: Act on form feed. n = n or N: Ignore from feed (default) Note: The form feed character (12 Always On decimal or 0C Hex) can be configured to...
- Page 31 Chapter 3: Using Easy Print Mode Configure Default Protocol {CL:nnn} Original Radio Ready MF2, MF3, 2t, 4t 2t, 3l, 4t A left bracket begins the command set. CL:nnn Changes the default protocol to one of the following: ESC :Line Printer Mode (default) EZ : Easy Print Mode EMC1 : Custom 1 EMC2 : Custom 2...
- Page 32 Chapter 3: Using Easy Print Mode RF Radio Power Down Timeout {CR:nn} Original Radio Ready MF2, MF3, 2t, 4t 2t, 3l, 4t A left bracket begins the command set. CR:nn This command turns off the radio if there is no activity in nnn minutes; it requires the user to turn the radio back on via button push before communications can resume.
-
Page 33: Three-Letter Configuration Commands
Chapter 3: Using Easy Print Mode Configure Carriage Return {CC:n} A left bracket begins the command set. CC:n Configures the carriage return to automatically add LF (line feed) to CR (carriage return) as follows: CR - CR Y - CR=CRLF (For PK printers only) A right bracket ends the command set. - Page 34 Chapter 3: Using Easy Print Mode Configure 802.11b/TCP/IP {CTC:n} A left bracket begins the command set. CTC:n Configures 802.11b/TCP/IP as follows: I:<data>- IP Address. The IP Address is sent in ASCII format as nnn.nnn.nnn.nnn. For example, {CTC:I:192.168.2.99} configures the printer's IP address to 192.168.2.99. The default IP Address is 192.168.2.99.
- Page 35 Chapter 3: Using Easy Print Mode Configure Bluetooth {CBT:n} Original Radio Ready MF2, MF3, 2t, 4t 2t, 3l, 4t A left bracket begins the command set. CBT:n Configures Bluetooth as follows: A:<string> - Authentication required. n = Y: Required; n = N: Not required B:n - Bondable.
- Page 36 Chapter 3: Using Easy Print Mode Configure CardReader {CCR:nnn} Original Radio Ready MF2, MF3, 2t, 4t 2t, 3l, 4t A left bracket begins the command set. CCR:nnn The CCR command requires data only to configure the general way the card reader uses the LED indicators when reading a card.
- Page 37 Chapter 3: Using Easy Print Mode Configure Infrared Protocol {CIP:nnn} Original Radio Ready MF2, MF3, 2t, 4t 2t, 3l, 4t A left bracket begins the command set. CIP:nnn Overview: The CIP command selects which protocol is to be used for Infrared communications.
- Page 38 Chapter 3: Using Easy Print Mode Configure IrDA Baud Name {CIN:string} Original Radio Ready MF2, MF3, 2t, 4t 2t, 3l, 4t A left bracket begins the command set. CIN:string Overview: The CIN command requires data only to configure the name given to the printer when it connects to an IrDA host.
- Page 39 Chapter 3: Using Easy Print Mode Configure Label Parameters {CLP:nn} Values/ Original Radio Format MF2, MF3, Ready 2t, 4t 2t, 3l, 4t A left bracket begins the command set. CLP:nn Use the following information to specify the parameters: B:nn - Back up distance at the nn in dotlines beginning of every Easy Print job.
- Page 40 Chapter 3: Using Easy Print Mode W:n - Use QMark stock with Windows n = Y : On (Look driver. for QMark) Note: If turned ON, the printer n = N : Off (Do automatically looks for the QMark at not look for end of Windows Driver (RLE) print job.
- Page 41 Chapter 3: Using Easy Print Mode Commit {COMMIT} A left bracket begins the command set. COMMIT Use the commit command to send two-letter configuration commands to the printer. When the commit command is sent, the configuration commands are written to Flash memory and the printer restarts.
-
Page 42: Querying The Printer
Querying the Printer Overview The printer can return a lot of information to the host. It can give some status of its current state as well as the current configuration. This is all done through a series of query commands that can be issued to the printer. Not all queries are available in all printers, and some queries are available in later versions of printer firmware;... -
Page 43: Query Commands
Chapter 4: Querying the Printer Query Commands Command Format Description Page Status ESC{ST?} Returns information about the ability of the printer to print the next image and reports any errors from the last print request (for example, paper condition, command errors, buffer size and battery voltage). -
Page 44: Status Query
Chapter 4: Querying the Printer Status Query Status Query Query Format ESC{ST?} Reply Format {ST!E:x;S:x;L:x;P:x;J:x;R:x;B:x;H:x} Function Returns information about the ability of the printer to print the next image and reports any errors from the last print request (for example, paper condition, command errors, buffer size and battery voltage). - Page 45 Chapter 4: Querying the Printer O = Printer was off during print out (available in Job Status only) P = Printing T = Timeout (available in Job Status only) Lever = Up or Down Paper = Present or Not present Head jam condition: N = No head jam;...
-
Page 46: Print Job Status Query
Chapter 4: Querying the Printer Print Job Status Query Print Job Status Query Query Format ESC{Sn?} Reply Format {ST!E:x;N:x;S:x;L:x;P:x;J:x;R:x;B:x} Function Verifies data delivered to the printer was printed without any mechanical errors such as a head jam or an out of paper condition. -
Page 47: Print Job Status Reply Explanation
Chapter 4: Querying the Printer Print Job Status Reply Explanation Query Reply Definition N = No error* c = Command error/invalid command d= Data error (for example, an alpha character in a numeric- only bar code) f = Font not available g = Global parameter error o = Overrun buffer* p = Field parameter error... -
Page 48: Configuration Query
Chapter 4: Querying the Printer Configuration Query Configuration Query Query Format ESC{CF?} Reply Format {CF!L:x; B:x; P:x; N:x; H:x;D:x;Y:x;S:x;M:x;T:x;R:x} Function Displays configurable options. Available for all printers except as noted. Reply Example {CF!L:LP;B:096;P:N;N:8;H:B;D:+10%;Y:1;S:Y;M:Y;T:0060 ;R:65535} Reply Example CF! - Reply to a configuration query. Explanation L:LP;... -
Page 49: Configuration Reply Explanation
Chapter 4: Querying the Printer Configuration Reply Explanation Query Reply Definition Auto White Space Advance LP, EZ Default mode = Line Printer (ESC) or Easy Print (EZ), The following are available for radio ready 2t/3l/4t printers: EMC1 (Custom 1), EMC2 (Custom 2), EMC3 (Custom 3), EMP1 (PGL), EMZ1 (CP CL), EMZ2 (Cog),EMZ3 (ZPL). -
Page 50: Battery Query
Chapter 4: Querying the Printer Battery Query Battery Query Original Radio Ready MF2/MF3/ 2t/3l/4t 2t/4t Query Format ESC{BT?} Reply Format {BT!V:x;T:x;CH:x} Function Returns current battery voltage and temperature. Reply Example {BT!V:6.8;T:+25.8C,CH:C, PS:B} Reply V:Voltage of single - n.n volts Parameters V1 and V2: Voltage of each of two batteries- n.n volts (for V1);... -
Page 51: Version Reply Explanation
Chapter 4: Querying the Printer Version Reply Explanation Query Reply Definition n.nn Firmware version is n.nn. n.nn Boot code version is n.nn. Download (fonts, graphics, formats) version is n.nn. Memory Query Memory Query Query Format ESC{MY?} Reply Format {MY!FS:x;FM:x;RS:x;DT:x;DR:x} Function Returns the size of all memory available in the printer, including the amounts used and the amount remaining. -
Page 52: Printhead Query
Chapter 4: Querying the Printer Printhead Query Printhead Query Query Format ESC{PH?} Reply Format {PH!TD:x;DD:x;T:x;M:x} Function Returns the printhead type used and the total number of dots across. Available for original MF2/MF3/2t/4t and radio ready 2t/3l/4t printers. Reply Example Thermal: {PH!TD:0384;DD:203;M:LPT3245;T:+25.6C;} Impact: {PH!IMPACT1;PINS:09;W:080} Reply Example Thermal:... -
Page 53: Infrared Query
DV:00; - The DIRECT version is 00. IV:1.0-06; - The IrDA version specification supported is 1.0 and the firmware is version 06. IN:microFlash2; - The device nickname is microFlash2. ID: - The device name is 1234567890123456789. O’Neil Programming Language Reference Manual... -
Page 54: Infrared Reply Explanation
Radio Ready 2t/3l/4t printers: Fixed:0.00 IrDA Name (unique across printers): The value returned for this parameter identify the printer type. Original MF2/MF3/2t/4t Printers: microFlash2, microFlash3, microFlash4, microFlash4CR, 2t, 2tCR Radio Ready 2t/3l/4t printers: Printer Type - 2tR, 3LR, 4tr Card Reader: Add S suffix Radio: Add 802 or add BT suffix IrDA Nickname. - Page 55 Chapter 4: Querying the Printer IrDA nickname, up to 19 characters. Uniquely identifies the printer, its communication capabilities and its microFlash2, peripherals. microFlash2, Thermal: 2t, 2i • 2tR - 2t Radio firmware with RS-232 only • 2tRBT - 2t Radio firmware with RS-232 and Bluetooth •...
-
Page 56: Font Query
Chapter 4: Querying the Printer Font Query Font Query Query Format ESC{FN?} Reply Format {FN!N5:x,N1:x,L:x,UV:x, UD:x,US:x, CPI:x} Function Lists fonts, both permanent and downloaded. Within a complete font definition, each query character is separated from the next with a comma (,). A semicolon, carriage return and line feed (;.<CR>, <LF>) separate each font. -
Page 57: Graphics Query
Chapter 4: Querying the Printer Graphics Query Graphics Query Query Format ESC{GR?} Reply Format {GR!N5:x,N1:x,L:D,UV:x,UD:x,US:x} Function Lists graphics currently downloaded to the printer. The reply is similar to the fonts query reply but without the font-related information. Each graphic present in the printer will return one complete set of all parameters below. -
Page 58: Formats Query
Chapter 4: Querying the Printer Formats Query Formats Query Query Format ESC{FM?} Reply Format {FM!N5:x,L:x,UV:x,UD:x,US:x} Function Lists formats downloaded to the printer. The reply is similar to the fonts query reply, but without the font-related information. Reply Example {FM!N5:LABEL,L:D,UV:1,UD:05/29/96,US:PROPERTY ID LABEL-BC} Reply Example FM! - Reply to a formats query. -
Page 59: 802.11B/Tcp/Ip Reply Explanation
Chapter 4: Querying the Printer 802.11b/TCP/IP Reply Explanation Query Reply Definition xxxxx Returns a variable length string specifying the ESSID (Extended Service Set Identification) configured in the printer. xxxxx Returns a string name specifying the station name. Connection - H=AdHoc mode; P=Print point mode. Dynamic Host Configuration Protocol (DHCP) status - N=DHCP is off;... -
Page 60: Bluetooth Query
Chapter 4: Querying the Printer Bluetooth Query Bluetooth Query Query Format ESC{BL?} Reply Format {BL!AD:x;F:x;SN:x;PR:x;CL:x;D:x;C:x;B:x;E:x;A:x;P:x;I: x;PWR:x;W:x} Function Returns the current Bluetooth configuration (if applicable). Reply Example {BL!AD:00:80:37:1A:0F:F7;F:Wireless Printer;SN:2t Bluetooth;PR:SPP;CL:040680;D:Y;C:Y;B:Y;E:N;A:N;P:Y; S:0;PWR:ON} Reply Example BL! - Reply to a Bluetooth query. Explanation AD:00:80:37:1A:0F:F7;... -
Page 61: Bluetooth Reply Explanation
Chapter 4: Querying the Printer Bluetooth Reply Explanation Query Reply Definition xx:xx:xx:xx: Returns the Bluetooth module's address. xx:xx xxxxx Returns the Bluetooth device name string. Note: In most printers, the device name is configured to the printer's serial number. xxxxx Returns the service name string. -
Page 62: Magnetic Card Configuration Query
Chapter 4: Querying the Printer Magnetic Card Configuration Query Magnetic Card Configuration Query Query Format ESC{MC?} Reply Format {MC!EN:x;DIR:x;T1:x;T2:x;T3} Function Displays the magnetic card reader configuration. Reply Example {MC!EN:ON;DIR:WITH;T1:ON;T2:ON;T3:ON} Reply MC! - Reply to a magnetic card configuration query. Explanation EN:ON;... -
Page 63: Magnetic Card Read Query
Chapter 4: Querying the Printer Magnetic Card Read Query Magnetic Card Read Query Query Format ESC{MR?} Reply Format {MR!T1:x|T2:x|T3:x|} Function Displays the magnetic card reader configuration. Reply Example No card read: {MR!T1:N|T2:N|T3:N} Card read: {MR!T1:%B9900 888888 89789^PUBLIC/JOHN Q ^9901960805542?|T2:;373027766473005=9901960805542 ?|T3:;1234567890=1234567890=1234567890= 1234567890?} Reply MR! - Reply to a magnetic card read query. -
Page 64: Card Reader Status Query
Chapter 4: Querying the Printer Card Reader Status Query Card Reader Status Query Query Format ESC{RS?} Reply Format {RS!P:n;S:n;G:n;R:n} Function Returns data read for a swiped magnetic card. The reply to the card reader status query can be automatically generated if the AutoSend option is on. -
Page 65: Label Configuration Query
Chapter 4: Querying the Printer Label Configuration Query Label Configuration Query Original Radio Ready MF2/MF3/ 2t/3t/4t 2t/4t Query ESC{CL?} Format Reply {CL!T:n;D:n;M:n;S:n;P:n;U:n;B:n;W:n} Format Reply {CL!T:P;D:1;M:1;S:T;P:Y;U:3;B:2;W:N} Example Reply CL! - Reply to a label configuration query. Explanation T: Type of stock used - P=Plain paper T=Top QMark B=Bottom QMark... -
Page 66: Serial Number Query: Esc {Sn
Chapter 4: Querying the Printer Serial Number Query: ESC {SN?} The serial number of the printer is returned, if the serial number has been written to the printer, otherwise the data field returned is None. Since the serial number is actually the parameter returned, there is no need for the Parameter:Data after the SN! in the response (SN!<serial number string>. -
Page 67: Table Of Contents
Table of Contents Numerics 802.11b/TCP/IP Query Easy Print Ahead command auto white space advance Ahead command Back command Auto White Space Advance Commands guidelines Back command commands Back Global Option configuration commands battery query overview overview configure 802.11b/TCP/IP Bluetooth configure battery eliminator configure baud rate cancel query configure beeper... - Page 68 Index (continued) EZ Print mode form feed PDF-417 symbols line feed Print Command reset printer Guidelines select font Print command select international character set back global option set double wide and high bar code field options set double wide print bar code names set form length font field options...
- Page 69 Index (continued) read magnetic card query overview reset query overview Restore Default Values RF Radio Power Down Timeout Rotate Global Option Self Test Print Self-Test Printout command sending queries Status command status query overview replies Stop Global Option Stores Default Values System Timeout version query overview...
Need help?
Do you have a question about the microFlash2 and is the answer not in the manual?
Questions and answers