B
Document Reference No. :
CS00145
Revision :
Status :
5
Issued
A-Series & A-Series plus
Codenet Communications Protocol
Software Interface Specification (Domino Part Number
27164)
Copyright © 2008, Domino UK Limited. The contents of this document are confidential and may not be
disclosed to any third party without prior written permission.
CS00145 - Issued 3
Codenet Communications Protocol
Modification Record
Issue
Date
Author
Changes (Including the change authority)
A
B
C
D
E
F
G
H
I
J
K
L
M
N
O
P
Q
R
S
T
U
V
to
separate
Original
Reviewed
Added Domino Part Number 27164
Added dotcode commands
Added Code 128 information for embedded
barcodes
Added download without save command
(OQ) and dotcode magnification mod (z)
Added 1.15 updates; Insert Logo, Insert
barcode text, Embedded Code 128 barcodes,
Julian Date, Language Date/Time; Status
Polling; Unicode character commands.
Added W, c, OH and info regarding CS00123
more extended commands
Changed details regarding the command @
Merged in some data missed out from an
earlier edition, (Change Height and Double
space) Added section detailing operation of
the Unicode Page Change commands.
Paginated
sections. Removed
reference to CS00123
Added Code 128 Auto codeset ABC
information for embedded barcodes
Added External Serial Number Reset,
Rollover and Update
Removed Reference to Snowflake 2 d codes
(CR014555)
Removed Handshaking section
Added Liquid Level Command for PI-OEM
(„y‟)
Removed
(RQ_PRINT_ID) 'A'
Added table information on the Print Height
command „OH‟
Some general updating
Included A-Series plus notes
Updated differences table for A-Series plus in
Section 16. Change request 390. Checked by
moderator RW.
Added the User Function Enable to the
embedded commands. Change request 529.
Checked by moderator RW
Changes to Barcode commands for A-Series
Identity
Printer
set
from
Copyright © 2008, Domino UK Ltd. The contents of this document are confidential and may not be disclosed
to any third party without prior written permission.
本文档仅授权统宝光电公司相关技术人员使用,未经授权而以任何形式透露给第三方,多米诺将保留追究法律责任的权力。
Page 2 of 90
CS00145 - Issued 3
Codenet Communications Protocol
W
X
28May08
T. Doan
1
10Jun08
R.Wilkins
1A
09Sep08
S. Luke
2
3
10Oct08
S. Luke
30 Oct 08
D Saravacos
4
25 Nov 08 O.
Escudero
5
17 July 09
Lara
Stephen
Chapman
for various
length details
plus (Section 9.9 and 8.6). Change request 560
(CS00145 Codenet protocol update for Aplus Barcodes).
Checked by moderator RW.
Updated the „f‟ command ( Bar Code Ratio,
CR#550)
Added TCP/IP implementation statements
(CR#522)
Included Variable response
(CR#543)
Verified by The moderator R. Wilkins
Added A-Series plus notes
commands.
Checked by moderators: Cameron Edgar,
Yafei Ping and Dimitris Saravacos
Moved to Software Quality Process document
format and numbering/issuing convention.
Additions for support of A-Series plus Duo
printer.
Changes after review 262. Checked by
moderator K. Telfer
Changes for change request 5653 as part of
peer review 270 (QRCodes). Checked by
moderator K. Telfer
Changes for defect DPSCM01515 as part of
peer review 278. Checked by moderator D.
Saravacos
Added in corrections and additions as given to
me by development.
Copyright © 2008, Domino UK Ltd. The contents of this document are confidential and may not be disclosed
to any third party without prior written permission.
本文档仅授权统宝光电公司相关技术人员使用,未经授权而以任何形式透露给第三方,多米诺将保留追究法律责任的权力。
Page 3 of 90
CS00145 - Issued 3
Codenet Communications Protocol
Contents
1. Purpose of document .......................................................................................... 7
2. References ......................................................................................................... 7
2.1. Glossary ................................................................................................................... 7
2.2. Document References ............................................................................................. 7
3. Hardware .......................................................................................................... 8
3.1. Serial Connection .................................................................................................... 8
3.1.1. Baud Rates ........................................................................................................... 8
3.1.2. Data Word ........................................................................................................... 9
3.2. TCP/IP connection ................................................................................................. 9
4. Printer Variants .................................................................................................. 9
4.1. A-Series plus Duo Support ....................................................................................... 9
4.2. Example Duo Message ........................................................................................... 10
5. Protocol .......................................................................................................... 12
5.1. General .................................................................................................................. 12
5.2.
Initialisation Commands ........................................................................................ 13
5.3. Print Control Commands ...................................................................................... 13
5.4. Printer Status Commands ....................................................................................... 13
5.5. Global Format Commands ..................................................................................... 13
5.6. Embedded Format Commands ............................................................................... 13
5.7. Application Specific Commands ............................................................................. 13
5.8. Extended Codenet Commands .............................................................................. 13
6.
Initialisation Commands and Responses .............................................................. 15
6.1. Printer Identity (RQ_PRINT_ID) 'A' ................................................................... 15
6.2. Printer Configuration (RQ_PRINT_CONFIG) 'B' ............................................... 15
6.3. Software Reset (SW_RESET) ................................................................. 17
6.4. Set the Printer Real Time Clock (INIT_CLOCK) „C‟ .......................................... 17
6.5. Read/Load Month Name Table (INIT_DATE_MONTHS) 'D' ............................ 18
6.6. Read/Load Day Name Table (INIT_DAYS) 'E' .................................................... 18
6.7. Read/Load Alpha Hours Characters (INIT_ALPHA) 'Y' ....................................... 19
6.8. Load/Read Character Set (CHAR_SET) 'X'.......................................................... 19
7. Printer Control Commands and Responses ......................................................... 21
7.1. Print Go Delay (SET_DELAY) 'F' ......................................................................... 21
7.2. Auto-repeat Printing (SET_REPEAT) 'G' ............................................................. 21
7.3. Continuous Printing (SET_CONTINUE) '[' ......................................................... 21
7.4. Auto-reverse Printing (SET_AUTOREV) 'H' ....................................................... 22
7.5. Auto-inverted Printing (SET_AUTOINV) '\' ........................................................ 22
7.6. Printing Acknowledgement Flags (SET_ACK) 'I' ................................................... 23
7.7. Flight Time Compensation (SET_FLIGHT_TIME) 'J' ........................................... 23
7.8. Active Product Detect Signal Level (SEL_P_GO_LEVEL) 'L' ................................ 24
7.9. Product Detect Signal Persistence Time (SET_P_GO_TIME) 'M' ......................... 25
7.10.
Software Print Go (SOFT_P_GO) 'N' ................................................................ 25
7.11. Message to Head Assignment (ASSIGN_MESS) 'P' ............................................. 25
Copyright © 2008, Domino UK Ltd. The contents of this document are confidential and may not be disclosed
to any third party without prior written permission.
本文档仅授权统宝光电公司相关技术人员使用,未经授权而以任何形式透露给第三方,多米诺将保留追究法律责任的权力。
Page 4 of 90
CS00145 - Issued 3
Codenet Communications Protocol
7.12. Head Enable (HEAD_ENABLE) 'Q' .................................................................. 26
7.13. Clear All Messages (CLEAR_ALL_MESS) 'R' .................................................... 26
7.14. Message Storage (MESSAGE) 'S'......................................................................... 26
7.15.
Product Counting (PROD_COUNT) 'T' .......................................................... 27
7.16. Read/Update Serial Number (SERIAL) 'U' ........................................................ 27
7.17. Get Software Real-time clock (GET_SW_RTC) 'Z' (Not Implemented) ........... 28
7.18. Read Stroke Output Period (STROKE_PERIOD) 'V' ....................................... 29
7.19. Read Modification Level (MOD_STATE) 'W' ................................................... 29
7.20. Handle Text (INSERT_TEXT)‟<‟ (A-Series plus specific) ..................................... 29
7.21. External Message Select (SET_EXTSEL) '@' ...................................................... 29
7.22. External Serial Number Reset, Rollover and Update (EXT_SERNO_CONFIG)
']'
30
8. Printer Status Commands and Responses ............................................................ 31
8.1. Status Reporting Mode (STATUS_REPORT_MODE) '0' .................................. 31
8.2. Status Request (STATUS) '1' ................................................................................. 32
9. Global Format Commands and Responses .......................................................... 34
9.1. Reverse Message Print Sequence (MESS_REV) 'a' ................................................. 34
9.2. Print Message Bold (MESS_BOLD) 'b' .................................................................. 34
9.3. Print Message Double Space (DOUBLE_SPACE) 'c' ............................................. 34
9.4. Reverse Individual Characters (CHAR_REV) 'd' .................................................. 35
9.5.
Inverted Printing (CHAR_INV) 'e' ....................................................................... 35
9.6. Barcode Thickness Ratio (BAR_RATIO) 'f' ......................................................... 35
9.7. Global Print Format (SET_FORMAT) 'g' ............................................................. 36
10. Embedded Commands and Responses ............................................................. 38
Insert Serial Number (INSERT_NUM) 'j' .......................................................... 38
10.1.
Start Bold Characters (START_BOLD) 'k' ......................................................... 39
10.2.
Select 2nd Character Font (FONT_2) 'l' ............................................................. 39
10.3.
Insert Logo (INSERT_LOGO) 'm' ..................................................................... 40
10.4.
Insert Date/Time (INSERT_CLOCK) 'n' ......................................................... 40
10.5.
10.6.
Insert Language Date/Time (INSERT_LANGUAGE_CLOCK) 'w' ................. 41
10.7. Offset Date/Time (OFFSET_CLOCK) 'o' ........................................................ 42
10.8.
Insert Time Conditional Print String (Time_Cond) 'p' ........................................ 43
Insert Barcode (INSERT_B_CODE) 'q' ............................................................ 43
10.9.
2D Codes (INSERT_D_CODE) „z‟ ................................................................ 45
10.10.
10.11.
Line Separator (NEW_LINE) 'r' ...................................................................... 49
Select 1st Character font (FONT_1) 't' ............................................................ 49
10.12.
Set Character Height (SET_HEIGHT) 'u' ....................................................... 49
10.13.
Stop Bold (STOP_BOLD) 'v' .......................................................................... 49
10.14.
10.15.
Change Unicode Page (SET_UNICODE_PAGE) 'h' ...................................... 49
10.16.
Select Character (SEND_CONTROL_CHAR) 'i' .......................................... 50
10.17. Read Liquid Levels (LIQUID_LEVELS) 'y' ..................................................... 50
10.18. User Function Enable (USER_ENABLE) '+' .................................................. 50
10.19.
Insert Bitmap (INSERT_BITMAP) 'x' (A-Series plus specific) ............................ 51
11. Application Specific Commands & Responses ................................................... 52
11.1. User Function Enable (USER_ENABLE) '+'...................................................... 52
Copyright © 2008, Domino UK Ltd. The contents of this document are confidential and may not be disclosed
to any third party without prior written permission.
本文档仅授权统宝光电公司相关技术人员使用,未经授权而以任何形式透露给第三方,多米诺将保留追究法律责任的权力。
Page 5 of 90
CS00145 - Issued 3
Codenet Communications Protocol
11.2. User Function Execute (USER-EXEC) '*' ......................................................... 52
12. Extended Codenet Commands ‘O’ .................................................................. 53
12.1. External Data Queues 'OE' 4Fh 45h ................................................................... 53
12.2.
Print Height (PRINT_HEIGHT) 'H' ................................................................. 53
12.3. Configure External Data Queue 'OP' 4Fh 50h ................................................... 54
12.4.
Sequence Control (SEQUENCE_CONTROL) 'S' ............................................ 55
12.5. Download message without save 'Q' ................................................................... 55
12.6. Get Current Status ( STATUS_POLL ) '1' .......................................................... 56
12.7. Get Current Alert ( ALERT_POLL) '2' .............................................................. 57
12.8.
Store Bitmap (STORE_BITMAP) 'OL' 4Fh 4Ch ............................................... 57
13. Print Message Entry ....................................................................................... 59
13.1. A-Series Example ............................................................................................... 59
13.2. A-Series plus Example ......................................................................................... 60
13.3. A-Series plus Duo Example ................................................................................. 61
Negative Acknowledgement Error Codes .................................................................. 62
14. Alert and Status Definitions ............................................................................ 65
15. A-Series plus Status Reporting ........................................................................ 75
16. ASCII Chart .................................................................................................. 79
17. Command Summary ..................................................................................... 80
18.
Index of Commands in Hexadecimal Order ..................................................... 85
19. Unicode Page Change Notes ........................................................................... 90
Copyright © 2008, Domino UK Ltd. The contents of this document are confidential and may not be disclosed
to any third party without prior written permission.
本文档仅授权统宝光电公司相关技术人员使用,未经授权而以任何形式透露给第三方,多米诺将保留追究法律责任的权力。
Page 6 of 90
CS00145 - Issued 3
Codenet Communications Protocol
1. Purpose of document
This document sets out to specify the protocol for communication between a remote controller and
the A-Series using CODENET protocol. This protocol is a subset of the 51000-Series Codenet
protocol. Due to fundamental differences in the technologies it is not possible to support all 51000-
Series commands. This document will also set out which commands are not supported and which
commands will respond differently. See the command summary for the commands that respond
differently. In some cases commands have become handlers that return the parameters sent by the host
taking no action on the data.
Details on the Codenet support for the A-Series plus, including Duo, printers have also been included.
2. References
2.1. Glossary
Term
Duo message
Jet 1 / Jet 2
Definition
The message for an A-Series plus Duo printer which contains the
information for both jets.
On a Duo printer, “Jet 1” / “Jet A” is the jet:
On the left with the wiring box at the top and the mounting plate at the
back
2.2. Document References
Reference Title
Version
Copyright © 2008, Domino UK Ltd. The contents of this document are confidential and may not be disclosed
to any third party without prior written permission.
本文档仅授权统宝光电公司相关技术人员使用,未经授权而以任何形式透露给第三方,多米诺将保留追究法律责任的权力。
Page 7 of 90
CS00145 - Issued 3
Codenet Communications Protocol
3. Hardware
The Codenet protocol can be used via either a serial RS232 interface or Ethernet TCP/IP interface.
3.1. Serial Connection
Serial Input pin connections as follows...
Bulgin Pin No
Signal Function
D-Type Pinout
1
2
3
4
5
6
7
8
9
Tx Data
printer
1
output
from
2
Rx Data input to printer
DSR Input
0v Signal ground
DTR Output
CTS Input
RTS Output
Screen
3
4
5
6
7
8
Shell
3.1.1. Baud Rates
Using the command (RQ_PRINT_CONFIG) part 'FF', the baud rate can be set to any one of those
listed below, provided that communication is initially established at one of the default rates set by
switches 1 and 2 on the serial interface DIL switches. The alternative rate is retained in battery-
backed memory and will only be reset to the switch settings following a clearing of the battery backed
memory.
Note: The last 3 Baud rates in the table below apply only to A-Series plus (38400, 57600, 115200).
There will be no jumper links for the A-Series plus. The default Baud rate, 9600, will be set in the
UI.
Available rates are as follows:-
Field 'FF'
Baud Rate
00
01
75
150
Copyright © 2008, Domino UK Ltd. The contents of this document are confidential and may not be disclosed
to any third party without prior written permission.
本文档仅授权统宝光电公司相关技术人员使用,未经授权而以任何形式透露给第三方,多米诺将保留追究法律责任的权力。
Page 8 of 90