You are on page 1of 47

CMC CARTONWRAP

CW1000

CIS release 2.3


Integration Protocol
with external Data Manager

CartonWrap CW1000 CIS Protocol release 2.3 – CMC confidential 1


Warning
This document contains proprietary information and cannot be reproduced, fully
or in part, without the written authorisation by CMC srl.
CMC srl reserves the right to make amendments and/or upgrades to the
software following the issuing of this document and therefore not reported in
this version.
Despite every reasonable effort made in drawing up this document in order to
assure adequate accuracy, CMC srl declines every responsibility with regard to
any errors and/or omissions or use of information contained in this document.

Copyright Notice
This document contains proprietary information and may not be reproduced in
whole or in part without the written permission of CMC srl.
CMC srl reserves the right to make product changes and improvements which
may not be reflected in this document version.
While reasonable efforts have been taken in the preparation of this document
to assure its accuracy, CMC srl assumes no liability resulting from any errors in
Content or omission or in the use of the information contained herein.

Revision History
Ver Date Author Comments
1.00 16 Mar 2015 C. Manenti First release of documentation
1.01 9 Apr 2015 C. Manenti Management CW500 and CW1000
1.02 19 Sep 2015 C. Manenti Management Invoice
1.03 17 Jan 2016 C. Manenti Added Client/Server socket
2.00 4 May 2016 C. Manenti Added new messages
2.01 13 Dec 2016 C. Manenti/F.Veneri Added check weight
2.02 3 May 2017 C. Manenti/F.Veneri Management IND message
2.02.1 27 May 2017 C. Manenti/F.Veneri Management PRN message
2.03 19 Feb 2018 C. Manenti/F.Veneri Management MachineID

CartonWrap CW1000 CIS Protocol release 2.3 – CMC confidential 2


This document contains all information related the integration of the CW1000 with an
external data manager Customer Information System (CIS)

CHECKWEIGHT
LABELLER
LAB
INV

PRN
END

ACK
IND

ENQ REM
Q

ITEM
BARCODE
READER

Item Flow
Carton Flow
Inserting Section
Invoice + Inserts
Item + Carton Flow
Labeler + Sorting

Note:
This layout is indicative and need to be considered only for evaluation purpose.

CartonWrap CW1000 CIS Protocol release 2.3 – CMC confidential 3


WHAT’S NEWS

In general this release 2.3 reflect the same logics of the previous releases but there are
some new parameters on messages to help the identification where more than one lines
are installed on the same production site.

- Added MACHINE_ID field at the beginning of each message

- Added ‘source of barcode’ on the ENQ message (optional)

- Added selectivity flag for label ‘HAZARD-MATERIAL’ on enq message (optional)

- Modified the max. length of feeder selectivity (up to 8) on enq message

NOTE:
All new features relate the new version are made in YELLOW EVIDENCE.

CartonWrap CW1000 CIS Protocol release 2.3 – CMC confidential 4


INDEX
Running Principle pag. 5
Operational Flow pag. 7
Message Flow pag. 8
Message Timing pag. 9

Protocol CIS 2.3 pag. 10

- Message ‘ENQ’ (from CW1000 to CIS) pag. 12


- Message ‘enq’ (from CIS to CW1000) pag. 13

- Message ‘IND’ (from CW1000 to CIS) pag. 18


- Message ‘ind’ (from CIS to CW1000) pag. 19

- Message ‘ACK’ (from CW1000 to CIS) pag. 20


- Message ‘ack’ (from CIS to CW1000) pag. 21

- Message ‘PRN’ (from CIS to CW1000) pag. 22


- Message ‘prn’ (from CW1000 to CIS) pag. 24

- Message ‘INV’ (from CW1000 to CIS) pag. 25


- Message ‘inv’ (from CIS to CW1000) pag. 26

- Message ‘LAB’ (from CW1000 to CIS) pag. 28


- Message ‘lab’ (from CIS to CW1000) pag. 31

- Message ‘END’ (from CW1000 to CIS) pag. 33


- Message ‘end’ (from CIS to CW1000) pag. 34

- Message ‘REM’ (from CW1000 to CIS) pag. 35


- Message ‘rem’ (from CIS to CW1000) pag. 36

- Message ‘HBT’ (from CW1000 to CIS) pag. 37


- Message ‘hbt’ (from CIS to CW1000) pag. 37

- Message ‘STS’ (from CIS to CW1000) pag. 38


- Message ‘sts’ (from CW1000 to CIS) pag. 39

List of events pag. 40

Devices
- Barcode Readers pag. 41
- Invoice Printer pag. 42
- Labeler pag. 42
- Check Weight pag. 43

CartonWrap CW1000 CIS Protocol release 2.3 – CMC confidential 5


RUNNING PRINCIPLE
CW1000 can run on 3 different modality:

- OFFLINE (only mechanical)


This modality can be selected for testing, training, maintenance etc.
On this modality all ‘data management’ are disabled (barcode, printers etc..)

- INTERNAL MODE
In this modality, CW1000 will read a barcode on the incoming section, will
track internally this barcode and will print on shipping label

- EXTERNAL MODE
In this modality, CW1000 can be connected to an External Customer
Information System (CIS) to exchange data using socket messages via
TCP/IP with the WMS Warehouse Management System.

The following documentation is related the EXTERNAL MODE using protocol CIS 2.3

PRODUCTION FLOW
When the operator ‘read’ the barcode on Item by hand scanner or optionally by camera
On Top, the CW1000 will send a message ‘ENQ’ (Enquire) to ‘CIS’ containing the barcode
just scanned.
‘CIS’ will reply to CW1000 with a MESSAGE ‘enq’ containing all product information
related this barcode (flag ValidCode ‘YES/NO’ ,description etc.. see below).

If Flag ValidCode is YES (the item is considered valid by CIS), the incoming belt will start
the movement (yellow arrow flow) and the item is inducted in the machine.

CW1000 will inform CIS about the item just started with the message ‘IND’ (inducted).

CW1000 will now measure the maximum 3 sizes (L,H,W) of item just inducted using the
3D dimensional bars.
Just after the 3D bars, CW1000 will send back the message ‘ACK’ to inform CIS if item is
‘accepted’ or not (may rejected because out of range).

If size of item is out of range (some sizes exceed the maximum allowed for this carton
width) , the CW1000 will divert automatically this item without stopping line, on the gate
just after the measurement bar.

If the item has been accepted, the CW1000 will proceed with Creation of Box on Forming
section (blue arrow flow) , will insert the item inside the box just composed (orange arrow
flow), will close the box (green arrow flow) and will delivery on output belt.

CartonWrap CW1000 CIS Protocol release 2.3 – CMC confidential 6


Just after receiving ‘ACK’, CIS will produce and send the data_label with the message
‘PRN’ to CW1000 who will store, buffering and send to printer on the correct timing.

Optionally (if installed) ,at the correct time CW1000 will request to print the invoice with
the MESSAGE ‘INV’; in this case, ‘CIS’ need to send the data formatted directly to the
laser printer (see above).

When the box is at the end of the line, just in front of thermal labeler , the CW1000 send
MESSAGE ‘LAB’ to ‘CIS’ within initial bar code , ReferenceID , box status (good or bad)
and all others data related this box (sizes , weight etc)

After the label is printed and applied , a bar code reader will verify the correct matching;
CW1000 will send MESSAGE ‘END’ within final box status and all information about box
(good or rejected, sizes etc).

Note: If the Item is “accepted” by the 3D bars , and has been removed manually from the
machine, CW1000 will send the MESSAGE ‘REM’ (removed) to indicate that the item is not
passed through the end of the machine.

CIS can check the current status of CW1000 at any time using the message ‘STS’ (status).
CMC will return and answer with the current status.

At any time, as debug or troubleshooting , there is an ‘heartbeat’ message to check the


connection between systems.
This message can be generated and sent ‘on demand’ either from CIS to CW1000 or from
CW1000 to CIS.

CartonWrap CW1000 CIS Protocol release 2.3 – CMC confidential 7


OPERATIONAL FLOW

Read barcode on Item


ENQ
No
Code ok?

Yes
Scan Dimension
ACK

No
Dim ok?

Yes
Divert Item out_format Insert Item on Box

Is there No
Invoice?

INV
Yes

Print Invoice

Is there No
checkweight?

Yes

Check the Weight

LAB
Labelling

No
Label ok?

Yes

END

Reject Boxed Item Good END

CartonWrap CW1000 CIS Protocol release 2.3 – CMC confidential 8


MESSAGE FLOW

CW1000 CIS (WMS)

Operator scan
barcode on item ( send ‘ENQ’ message with barcode content

CIS receive the barcode and


‘enq’ message with all item info and reference send the info related the item
CW1000 will display info and will assign a ‘unique reference’
on HMI screen

If item is ‘valid’ will start send ‘IND’ with reference to inform the item is inducted CIS receive the message and will
the incoming belt ‘lock’ the item on the own database
‘ind’ message just to confirm (optional)

The Item is measured send ‘ACK’ with reference and flag GOOD or OUTFORMAT CIS will receive the flag if item is
on 3D scanner PROCESSABLE or OUT_OF_FORMAT
‘ack’ message just to confirm (optional) (and then rejected on the first gate).

‘PRN’ message with data_label CIS will send the Data_Label in ZPL
If the ACK is valid
CW1000 will create the Send ‘prn’ message just to confirm (optional

Box and will insert item


On the box.

If Invoice is requested, send ‘INV’ request Print Invoice with reference CIS will send the invoice data to
CW1000 will ask to print the laser printer and will return the
‘inv’ message with reference and result and barcode match Result to CW1000 (printed)

CW1000 will insert the


Invoice on box and will
close the box.

At the end of the line send ‘LAB’ request Print Label with reference and all info weight,size,status. CIS will send the result to
CW1000 will ask the CW1000 (good weight or not)
Label on thermal
‘lab’ message with reference and result and barcode match

If the box is removed send ‘REM’ removed with reference CIS will be informed about this box
(never exit) we send the has been removed
Related message ‘rem’ message just to confirm (optional)

CW1000 will read the


Barcode on label
And will decide to reject
Or delivery on output.

CW1000 will send the send ‘END’ message with reference and all info Weight..Good.. CIS will receive the final message
Final result to CIS with all info as : sizes, good, bad,
Weight etc.
‘end’ message just to confirm (optional)

CartonWrap CW1000 CIS Protocol release 2.3 – CMC confidential 9


MESSAGE TIMING

t0 Time when the operator ‘scan’ the item


t1 Time when CW1000 receive the info related the item
t2 Time when the item start the induction (if product is valid)
t3 Time when item has been measured and size are checked
t4 Time when CW1000 require to print the Invoice (optional)
t5 Time when the customer have sent the invoice data to the printer
t6 Time when the box exit from the machine and CW1000 require the label (max allowed for PRN)
t7 Time when the customer have sent the label data to thermal printer
t8 Time when the printer have received data and printed the label
t9 Time when the label has been applied
t10 Time when the barcode reader have verified the label correct

CartonWrap CW1000 CIS Protocol release 2.3 – CMC confidential 10


CIS PROTOCOL rel 2.3

TCP SOCKET
To send/receive information between CW1000 and CIS, we use TCP socket messages
Client/Server methodology.

CW1000 can be declared as Client or Server on the TCP/IP communication according the
customer preferences.

As default CW1000 is Server.

If CMC is declared as CLIENT, CW1000 will continuously retry to open the connection if
close or in error (connect) every 3 seconds.

If CMC is declared as SERVER, CW1000 will stay in Listen on a definable port on the IP
address of the PC socket card , waiting for connection request.
As default the listening port is ‘10001’ (can be changed on the .INI file)

PLEASE NOTE:
Due to the unpredictable position of the items and boxes, some messages can be sent and
received ‘very close’ between them.

Example:
When the operator scan an item, CW1000 send the ‘ENQ’ message but on the same time
may be another box is under the printer and then CW1000 send ‘LAB’ message.

In order to prevent communication compliances, CW1000 will ensure in any cases a


minimum time gap between messages of 50 ms.

CartonWrap CW1000 CIS Protocol release 2.3 – CMC confidential 11


MESSAGES STRUCTURE
Messages will follow those common rules:

FRAME
Each message will start with <STX> (0x02 hex) and will be ended by <ETX> (0x03 hex)

Example:
<stx>0001|ENQ|1|200001234|<etx>

MACHINE ID
After the <STX>there is the Machine ID:
Example:
<stx>0001|ENQ|1|200001234|<etx>

MESSAGE TYPE
After the MachineID there are 3 chars to identify the Message Type:
Example:
<stx>0001|ENQ|1|200001234|<etx>

FIELD SEPARATOR
All fields are separated by delimiter Pipe “|”
Example:
<stx>0001|ENQ|1|200001234|<etx>

SENDER & RECEIVER


If the Message Type is in CAPITAL LETTERS means is GENERATED BY THE SENDER TO THE
RECEIVER DIRECTION (REQUEST MESSAGE)
Example of senders:
<stx>0001|ENQ|1|200001234|<etx>

If the Message Type is in lower case letters means is the ANSWER TO RELATED MESSAGE
(from Receiver to Sender direction)
Example of return from receiver:
<stx>0001|enq|1|1|0|0101|4|200001234|000ABCD|IABD|LAB|860|Book|<etx>

MESSAGE PAIRED
All messages are ‘paired’ : for each message sent need to return an answer message.
Example:

Tx : <stx>0001|ENQ|1|200001234|<etx>
Rx : <stx>0001|enq|1|1|0|0101|4|200001234|000ABCD|IABD|LAB|860|Book|<etx>

DEFAULT VALUES
All numeric values not populated must be ‘0’ (zero)
All Alphanumeric values not populated must be ‘’ (empty/blank)

Example:
<stx>0001|enq|1|000ABCD|1|1|||200001234|INVABCD|LABELABCD||Book Photo|||<etx>
(empty alphanumeric fields)

CartonWrap CW1000 CIS Protocol release 2.3 – CMC confidential 12


MESSAGE ‘ENQ’ (from CW1000 to CIS)
This message contains the request of information relate the bar code read from operator on item at the
start of the line.
It’s sent every time a scanning has been made.

MESSAGE “ENQ”
CODE DESCRIPTION
MSG_START STX = 0x02
MSG_MACHINE_ID From 0 to 999999 (from .INI)
separator “|”
MSG_TYPE “ENQ” ( Fixed)
separator “|”
MSG_COUNTER From 1 to 999999 (generated by CMC)
separator “|”
MSG_BARCODE BARCODE ON ITEM (Max 100 chars)
separator “|”
MSG_SOURCE (optional) Source of barcode (0=Automatic Scanner 1=Ethernet Scanner 2=Keyboard)
separator “|”
MSG_END ETX = 0x03

Example:
<stx>0001|ENQ|1|200001234|[0|]<etx>

MSG_START
Character Qualifier of ‘Start Of Message’ (0x02 ASCII)
LEN =1 char (fixed)

MSG_MACHINE_ID
This Code Machine ID is the identification of the line stored on the internal .INI file and is sent at the
beginning of all messages (from CW1000 to CIS and viceversa)
Range=from 0 to 999999
LEN =from 1 to 6 chars

MSG_TYPE
Type of message : ‘ENQ’ (enquire)
LEN =3 char (fixed)

MSG_COUNTER
Message counter increased of one unit by CW1000 every time a new message is sent to CIS
Range=from 1 to 999999
LEN =from 1 to 6 chars

MSG_BARCODE
Code read on barcode item ‘as is’ with hand scanner (or optionally, with camera on top)
LEN =from 1 to 100 chars

MSG_SOURCE
Source of the barcode : 0=Automatic Scanner 1=Ethernet Scanner 2=Entered by keyboard
NOTE:
This field can be omitted on transmission based on the parameter on .INI file

MSG_END
Character Qualifier of ‘End Of Message’ (0x03 ASCII)
LEN =1 char (fixed)

CartonWrap CW1000 CIS Protocol release 2.3 – CMC confidential 13


MESSAGE ‘enq’ (response from CIS to CW1000)
This message contains the answer at Message ‘ENQ’ and must be send back immediately
to CW1000 (time out 500 mS) to prevent delays on production.
After the 1,5 second (1500 mS), we display a ‘red message’ on screen with the indication
related the ‘TimeOut’ receiving answer from Server.
In any case, also if the message is received delayed (over the timeout), CMC will accept
the message , will display the content and will allow to induct the item.
Please considering, to reach the speed 1000 p/h , the global time to : scan , send ‘ENQ’,
receive valid ‘enq’, induct product , need to be less than 3.6 seconds otherwise the
productivity of the machine will be reduced.
MESSAGE “enq”
CODE DESCRIPTION
MSG_START STX = 0x02
MSG_MACHINE_ID From 0 to 999999 (reply (reply the msg_machine_ID received on ‘ENQ’)
separator “|”
MSG_TYPE “enq” ( Fixed)
separator “|”
MSG_COUNTER From 1 to 999999 (reply the msg_counter received on ‘ENQ’)
separator “|”
MSG_REFERENCE REFERENCE FOR TRACKING (max 50)
separator “|”
MSG_RESULT 0=Error/Not found 1=good item 2=good but partial
separator “|”
MSG_FLAG_INVOICE ** 0=No invoice 1/2/3=number of pages to print on Laser (from 1 to 3)
separator “|”
MSG_SELECTIVE ** ‘00000000’=No Selective ‘11111111’=Selectivity (enable from 1 to 8)
separator “|”
MSG_SORTER ** 1..15 =Number of out gate on sorter
separator “|”
MSG_BARCODE BARCODE (reply from msg_barcode received on ‘ENQ’)
separator “|”
MSG_MATCH_INV ** REFERENCE FOR MATCHING ON INVOICE (max50 chars)
separator “|”
MSG_MATCH_LAB REFERENCE FOR MATCHING ON LABEL (max50 chars)
separator “|”
MSG_DESCRIPTION DESCRIPTION TO BE DISPLAY (max 300 chars)
separator “|”
MSG_REF_COLORPRINT ** REFERENCE to send on color printer on this box (max50 chars)
separator “|”
MSG_MATCH_COLORPRINT ** REFERENCE FOR MATCHING ON COLORPRINT (max 50 chars)
separator “|”
MSG_FLAG_BOX_LOW FLAG TO INDICATE THE LOW HEIGHT OF BOX
separator “|”
MSG_FLAG_HAZMAT_LAB (opt.) FLAG TO APPLY THE HAZARDMATERIAL LABEL
separator “|”
MSG_END ETX = 0x03

** = Fields populated only if the related modules are installed on the CW1000.

Example:
<stx>0001|enq|1|000ABCD|1|1|11000000|2|200001234|INVABCD|LABELABCD||Book1|img1.jpg|123|0|[0|]<etx>

CartonWrap CW1000 CIS Protocol release 2.3 – CMC confidential 14


MSG_START
Character Qualifier of ‘Start Of Message’ (0x02 ASCII)
LEN =1 char (fixed)

MSG_MACHINE_ID
Machine ID is the identification of the line involved by this message and is the reply from the ENQ message
received; this value will be compared with the own MachineID stored on the INI file.
Range=from 0 to 999999
LEN =from 1 to 6 chars

MSG_TYPE
Type of message : ‘enq’ (answer result of enquire)
LEN =3 char (fixed)

MSG_COUNTER
Message counter replied from message ENQ received
Range=from 001 to 999999
LEN =from 1 to 6 chars

MSG_REFERENCE
This field contain the ‘CIS internal ID Reference Code’ (assigned by customer)
This field will be used as ID on all others messages related this Barcode/Item/Reference
This ID must be a unique key assigned by CIS
LEN =from 1 to 50 chars
Note:
We use MSG_REFERENCE in order to have a unique key assigned by CIS; in fact, using the barcode
scanned, we may have duplicates (same products for different customers) and then potential troubles on
data integrity.

MSG_RESULT
This Flag will indicate if the Item has been detected and considered valid on CIS :

0=Item not found / not valid on CIS database ; the pop-up will show MSG_description
the screen pop-up become red and induct belt not start

1=Item found and valid ; the pop-up will show MSG_description


the screen pup-up become green and the induct belt will start (when item detected)

2=Item found but is part of multi-items ; the pop-up will show MSG_description
In this case, the pop-up become yellow and the induct belt will not start (waiting for others items or
others actions as ‘scan serial number etc…)
CW1000 still waiting for another ‘enq’ with MSG_RESULT = ‘1’

MSG_INVOICE
This Flag will indicate if there is an Invoice to print for this item.
0=no invoice for this item or printer not installed
1/2/3=Number of pages to print for this item on the laser.
NOTE:
The INVOICE CHANNEL is an option on the CW1000 ; if the CW1000 is not equipped with the INVOICE this
field should be Empty or Zero.

CartonWrap CW1000 CIS Protocol release 2.3 – CMC confidential 15


MSG_SELECTIVE
If the MTD4 is installed (feeder module), those 8 Flags (one for each feeder) will indicate which feeder need
to be enabled for this Item :
LEN =8 char

0=Feeder1 - No inserts
1=Feeder1 - Yes, There is an insert

0=Feeder2 - No inserts
1=Feeder2 - Yes, There is an insert

0=Feeder3 - No inserts
1=Feeder3 - Yes, There is an insert

0=Feeder4 - No inserts
1=Feeder4 - Yes, There is an insert

0=Feeder5 - No inserts
1=Feeder5 - Yes, There is an insert

Empty = Feeder Channel not installed or no selectivity

Example: 0 0 1 0 0 0 0 0
F1 F2 F3 F4 F5 F6 F7 F8

no no YES no no no no no
NOTE:
The Feeder management is an option on the CW1000 (see below FEEDER MANAGEMENT); if the CW1000 is
not equipped with the FEEDER CHANNEL this field need to be empty.

MSG_SORTER
This value will indicate the OUTPUT GATE at the end of the line where Box need to be diverted (from 1 to x)
Range=1 to x ( max number of OUTPUT GATE)
Empty = SORTER not installed
LEN=1 or 2 chars

NOTE:
If the number indicate on this flag is not valid (zero or over max) we will divert the box on the ‘default gate’
as on setting of the machine

NOTE:
The SORTER is an option on the CW1000 ; if the CW1000 is not equipped with the SORTER this field should
be empty or Zero.

CartonWrap CW1000 CIS Protocol release 2.3 – CMC confidential 16


MSG_BARCODE
This field contain the reply of BarCode received on Message ‘ENQ’ and is used as a double check for the
validation of this message.
LEN =from 1 to 100 chars

MSG_MATCH_INV
After the Invoice Laser printer there is a barcode reader to read bar code (1D or 2D) printed on the top of
the invoice. This bar code will be compared with MSG_MATCH_INV to verify and validate the invoice.
If this string is empty the comparison will be skipped.
LEN =from 1 to 50 chars

NOTE:
To allow the matching reading, the barcode need to be printed on a readable position on the invoice paper
in order to be read by the camera on top.

NOTE:
This field can be sent also later on message ‘inv’ (see) if not available at the ‘enq’ time; in this case need to
be forced to empty.

NOTE:
The INVOICE CHANNEL is an option on the CW1000 ; if the CW1000 is not equipped with the INVOICE this
field should be empty.

MSG_MATCH_LAB
After the Labeler Thermal Printer there is a barcode reader to read bar code (1D or 2D) printed on the label.
This bar code will be compared with MSG_MATCH_LAB
If this string is empty the comparison will be skipped.
LEN =from 1 to 50 chars
NOTE:
This field can be sent also later on message ‘lab’ (see) if not available at the ‘enq’ time.

CartonWrap CW1000 CIS Protocol release 2.3 – CMC confidential 17


MSG_DESCRIPTION
This field contain the Description of the Item to be displayed on the screen pup-up.
Please note, may not all 300 chars can be displayed ; in fact, due to the font used and/or the auto alignment
of the text box , some chars can result ‘out of display box’ and not visible.
LEN =from 0 to 300 chars

MSG_COLORPRINTER
This field contain the name of the image to be print with the ColorPrinter on top side of the box.
CW1000 will track this reference and will send to the printer on the related box.
LEN =from 0 to 50 chars
NOTE:
The COLORPRINTER is an option on the CW1000 ; if the CW1000 is not equipped with the COLORPRINTER
this field should be empty.

MSG_MATCH_COLORPRINTER
After the ColorPrinter there is a barcode reader to read bar code (1D or 2D) printed in the image.
This bar code will be compared with MSG_MATCH_COLORPRINTER to verify and validate the printer.
If this string is empty the comparison will be skipped.
LEN =from 1 to 50 chars

NOTE:
The COLORPRINTER is an option on the CW1000 ; if the CW1000 is not equipped with the COLORPRINTER
this field should be empty.

MSG_FLAG_BOX_LOW
If this flag is ‘1’, the CW1000 will considering this item (and the related box) as BOX_LOW ; in this case, the
height if the box will be defined and forced by the panel operator of the machine and not from the 3Dbars.
The others two dimensions (‘L’ and ‘W’) will be detected in any case from the 3Dbars.
LEN =1 char

MSG_FLAG_HAZMAT_LABEL
If this flag is ‘1’, the CW1000 will apply an extra label for the hazardous material (preprinted) at the end of
the line with a dedicated applier .
LEN =1 char
NOTE:
This field can be omitted ; if omitted CW1000 will assume the value to ‘0’

MSG_END
Character Qualifier of ‘End Of Message’ (0x03 ASCII)
LEN =1 char (fixed)

CartonWrap CW1000 CIS Protocol release 2.3 – CMC confidential 18


MESSAGE ‘IND’ (from CW1000 to CIS)
This message is sent ‘when the item is inducted on machine’ (product is just started on
the incoming belt).
This message is usefully to ‘lock’ this item on the customer database in case of multi
requests from different lines.

MESSAGE “IND”
CODE DESCRIPTION
MSG_START STX = 0x02
MSG_MACHINE_ID From 0 to 999999 (from .INI)
separator “|”
MSG_TYPE “IND” ( Fixed)
separator “|”
MSG_COUNTER From 1 to 999999
separator “|”
MSG_REFERENCE REFERENCE FOR TRACKING
separator “|”
MSG_END ETX = 0x03

Example:
<stx>0001|IND|6|00ABCD|<etx>

MSG_START
Character Qualifier of ‘Start Of Message’ (0x02 ASCII)
LEN =1 char (fixed)

MSG_MACHINE_ID
This Code Machine ID is the identification of the line stored on the internal .INI file and is sent at the
beginning of all messages (from CW1000 to CIS and viceversa)
Range=from 0 to 999999
LEN =from 1 to 6 chars

MSG_TYPE
Type of message : ‘IND’ (Item Inducted)
LEN =3 char (fixed)

MSG_COUNTER
Message counter increased of one unit by CW1000 every time a new message is sent to CIS
Range=from 1 to 999999
LEN =from 1 to 6 chars

MSG_REFERENCE
This field contain the ‘ID Reference Code’ as indicated on message ‘enq’ from CIS
LEN =from 1 to 50 chars

MSG_END
Character Qualifier of ‘End Of Message’ (0x03 ASCII)
LEN =1 char (fixed)

CartonWrap CW1000 CIS Protocol release 2.3 – CMC confidential 19


MESSAGE ‘ind’ (response from CIS to CW1000)
This is a feedback message when CIS receive message ‘IND’
Not critical for timing point of view (used only to pair the message IND)
MESSAGGIO “ind”
CODE DESCRIPTION
MSG_START STX = 0x02
MSG_MACHINE_ID From 0 to 999999 (reply the msg_machine_ID received on ‘IND’)
separator “|”
MSG_TYPE “ind” ( Fixed)
separator “|”
MSG_COUNTER From 1 to 999999 (reply the msg_counter received on ‘IND’)
separator “|”
MSG_REFERENCE REFERENCE FOR TRACKING (reply from msg_reference on ‘IND’)
separator “|”
MSG_END ETX = 0x03

Example:
<stx>0001|ind|6|00ABCD|<etx>

MSG_START
Character Qualifier of ‘Start Of Message’ (0x02 ASCII)
LEN =1 char (fixed)

MSG_MACHINE_ID
Machine ID is the identification of the line involved by this message and is the reply from the IND message
received; this value will be compared with the own MachineID stored on the INI file.
Range=from 0 to 999999
LEN =from 1 to 6 chars

MSG_TYPE
Type of message : ‘ind’ (result of acknowledge)
LEN =3 char (fixed)

MSG_COUNTER
Message counter replied from message IND received
Range=from 1 to 999999
LEN =1 to 6

MSG_REFERENCE
This field contain the ‘ID Reference Code’ as indicated on message ‘enq’ from CIS
LEN =from 1 to 50 chars

MSG_END
Character Qualifier of ‘End Of Message’ (0x03 ASCII)
LEN =1 char (fixed)

CartonWrap CW1000 CIS Protocol release 2.3 – CMC confidential 20


MESSAGE ‘ACK’ (from CW1000 to CIS)
This message contains the status of item just measured by 3D bars on infeed section
(Accepted or rejected if it is out_of_range)

MESSAGE “ACK”
CODE DESCRIPTION
MSG_START STX = 0x02
MSG_MACHINE_ID From 0 to 999999 (from .INI)
separator “|”
MSG_TYPE “ACK” ( Fixed)
separator “|”
MSG_COUNTER From 1 to 999999
separator “|”
MSG_REFERENCE REFERENCE FOR TRACKING
separator “|”
MSG_RESULT 0=Bad Item/Out Format/rejected 1=Ok, Item accepted!
separator “|”
MSG_END ETX = 0x03

Example:
<stx>0001|ACK|6|00ABCD|1|<etx>
MSG_START
Character Qualifier of ‘Start Of Message’ (0x02 ASCII)
LEN =1 char (fixed)

MSG_MACHINE_ID
This Code Machine ID is the identification of the line stored on the internal .INI file and is sent at the e
beginning of all messages (from CW1000 to CIS and viceversa)
Range=from 0 to 999999
LEN =from 1 to 6 chars

MSG_TYPE
Type of message : ‘ACK’ (acknowledge)
LEN =3 char (fixed)

MSG_COUNTER
Message counter increased of one unit by CW1000 every time a new message is sent to CIS
Range=from 1 to 999999
LEN =from 1 to 6 chars

MSG_REFERENCE
This field contain the ‘ID Reference Code’ as indicated on message ‘enq’ from CIS
LEN =from 1 to 50 chars

MSG_RESULT
This Flag will indicate if the Item has been accepted on machine after the Measurement bars
or is Out of Format :
0=Item Out of Format (will be rejected)
1=Item Accepted correctly
LEN =1 char

MSG_END
Character Qualifier of ‘End Of Message’ (0x03 ASCII)
LEN =1 char (fixed)

CartonWrap CW1000 CIS Protocol release 2.3 – CMC confidential 21


MESSAGE ‘ack’ (response from CIS to CW1000)
This is a feedback message when CIS receive message ‘ACK’
Not critical for timing point of view (used only to pair the message ACK)
MESSAGGIO “ack”
CODE DESCRIPTION
MSG_START STX = 0x02
MSG_MACHINE_ID From 0 to 999999 (reply (reply the msg_machine_ID received on ‘ACK’)
separator “|”
MSG_TYPE “ack” ( Fixed)
separator “|”
MSG_COUNTER From 1 to 999999 (reply the msg_counter received on ‘ACK’)
separator “|”
MSG_REFERENCE REFERENCE FOR TRACKING (reply from msg_reference on ‘ACK’)
separator “|”
MSG_END ETX = 0x03

Example:
<stx>0001|ack|6|00ABCD|<etx>

MSG_START
Character Qualifier of ‘Start Of Message’ (0x02 ASCII)
LEN =1 char (fixed)

MSG_MACHINE_ID
Machine ID is the identification of the line involved by this message and is the reply from the ACK message
received; this value will be compared with the own MachineID stored on the INI file.
Range=from 0 to 999999
LEN =from 1 to 6 chars

MSG_TYPE
Type of message : ‘ack’ (result of acknowledge)
LEN =3 char (fixed)

MSG_COUNTER
Message counter replied from message ACK received
Range=from 1 to 999999
LEN =1 to 6 3 chars

MSG_REFERENCE
This field contain the ‘ID Reference Code’ as indicated on message ‘enq’ from CIS
LEN =from 1 to 50 chars

MSG_END
Character Qualifier of ‘End Of Message’ (0x03 ASCII)
LEN =1 char (fixed)

CartonWrap CW1000 CIS Protocol release 2.3 – CMC confidential 22


MESSAGE ‘PRN’ (from CIS to CW1000)
This message contain the data_label in ZPL language to be sent at the thermal printer at
the correct timing.
This message need to be sent after CIS receive ‘ACK’=1 (Item has been accepted)
This message need to be sent before the Item has been boxed and exit of machine

MESSAGE “PRN”
CODE DESCRIPTION
MSG_START STX = 0x02
MSG_MACHINE_ID From 0 to 999999 (reply (reply the msg_machine_ID received on ‘ENQ’)
separator “|”
MSG_TYPE “PRN” ( Fixed)
separator “|”
MSG_COUNTER Counter of message generated by CIS
separator “|”
MSG_REFERENCE REFERENCE FOR TRACKING
separator “|”
MSG_LEN_DATA Number of bytes of Label_data
separator “|”
MSG_LABEL_DATA <stream of data to be sent at the thermal printer>
separator “|”
MSG_END ETX = 0x03

Example:
<stx>0001|PRN|6|ABCD123|131|^XA
^BY5
^FO390,080^BCR,200,N,N,N,A^FD123456^FS
^CFQ,50,70
^FO240,050^FWR^FDCMCsrl^FS
^CFQ,50,70
^FO160,050^FWR^FDITALY^FS
^XZ
|<etx>

MSG_START
Character Qualifier of ‘Start Of Message’ (0x02 ASCII)
LEN =1 char (fixed)

MSG_MACHINE_ID
Machine ID is the identification of the line involved by this message and is the reply from the ENQ message
received; this value will be compared with the own MachineID stored on the INI file.
Range=from 0 to 999999
LEN =from 1 to 6 chars

CartonWrap CW1000 CIS Protocol release 2.3 – CMC confidential 23


MSG_TYPE
Type of message : ‘PRN’ (PrintDataLabel)
LEN =3 char (fixed)

MSG_COUNTER
Message counter increased of one unit by CIS every time a new message is sent
This number can be used by CIS to ‘check’ the correct sequence of messages.
Range=from 1 to 999999
LEN =from 1 to 6 chars

MSG_REFERENCE
This field contain the ‘ID Reference Code’ as indicated on message ‘enq’ from CIS
LEN =from 1 to 50 chars

MSG_LEN_DATA
This field contain the number of bytes of the MSG_LABEL_DATA
To check if all data has been received correctly
Range=from 0 to 32700 (32kbyte max)

MSG_LABEL_DATA
This field contain the stream of the label in ZPL language already formatted and prepared to be interpreted
directly by the thermal print head (please refer to Zebra documentation for more info related ZPL or ZPLII).
CW1000 will receive this stream, will keep on buffering and will send to the printer ‘as is’ without any
manipulation

MSG_END
Character Qualifier of ‘End Of Message’ (0x03 ASCII)
LEN =1 char (fixed)

CartonWrap CW1000 CIS Protocol release 2.3 – CMC confidential 24


MESSAGE ‘prn’ (response from CW1000 to CIS)
This is a feedback message when CW1000 receive message ‘PRN’
(used only to pair the message ACK)
MESSAGGIO “prn”
CODE DESCRIPTION
MSG_START STX = 0x02
MSG_MACHINE_ID From 0 to 999999 (from .INI)
separator “|”
MSG_TYPE “prn” ( Fixed)
separator “|”
MSG_COUNTER From 1 to 999999 (reply the msg_counter received on ‘PRN’)
separator “|”
MSG_REFERENCE REFERENCE FOR TRACKING (reply from msg_reference on ‘PRN’)
separator “|”
MSG_RESULT RESULT OF MESSAGE 0=Bad /not correct 1=OK ACCEPTED
separator “|”
MSG_END ETX = 0x03

Example:
<stx>0001|prn|6|ABCD123|1|<etx>

MSG_START
Character Qualifier of ‘Start Of Message’ (0x02 ASCII)
LEN =1 char (fixed)

MSG_MACHINE_ID
This Code Machine ID is the identification of the line stored on the internal .INI file and is sent at the e
beginning of all messages (from CW1000 to CIS and viceversa)
Range=from 0 to 999999
LEN =from 1 to 6 chars

MSG_TYPE
Type of message : ‘prn’ (result of printing data)
LEN =3 char (fixed)

MSG_COUNTER
Message counter replied from message PRN received
Range=from 1 to 999999
LEN =1 to 6 3 chars

MSG_REFERENCE
This field contain the ‘ID Reference Code’ as indicated on message ‘enq’ from CIS
LEN =from 1 to 50 chars

MSG_RESULT
This Flag will indicate if the message has been accepted on machine or was not correct
0=Label Message not correct (will be printed an error label)
1=Label Accepted correctly
LEN =1 char

MSG_END
Character Qualifier of ‘End Of Message’ (0x03 ASCII)
LEN =1 char (fixed)

CartonWrap CW1000 CIS Protocol release 2.3 – CMC confidential 25


MESSAGE ‘INV’ (from CW1000 to CIS)
This message contains the request of Invoice to be print on laser printer
NOTE:
The INVOICE CHANNEL is an option on the CW1000 ; if the CW1000 is not equipped with the INVOICE this
message will be not sent

MESSAGE “INV”
CODE DESCRIPTION
MSG_START STX = 0x02
MSG_MACHINE_ID From 0 to 999999 (from .INI)
separator “|”
MSG_TYPE “INV” ( Fixed)
separator “|”
MSG_COUNTER From 1 to 999999
separator “|”
MSG_REFERENCE REFERENCE FOR TRACKING
separator “|”
MSG_PAGES Number of pages to be print (as declared on the ‘enq’ message)
separator “|”
MSG_END ETX = 0x03

Example:
<stx>0001|INV|6|00ABCD|1|<etx>
MSG_START
Character Qualifier of ‘Start Of Message’ (0x02 ASCII)
LEN =1 char (fixed)

MSG_MACHINE_ID
This Code Machine ID is the identification of the line stored on the internal .INI file and is sent at the e
beginning of all messages (from CW1000 to CIS and viceversa)
Range=from 0 to 999999
LEN =from 1 to 6 chars

MSG_TYPE
Type of message : ‘INV’ (acknowledge)
LEN =3 char (fixed)

MSG_COUNTER
Message counter increased of one unit by CW1000 every time a new message is sent to CSI
Range=from 1 to 999999
LEN =1 to 6 chars (fixed)

MSG_REFERENCE
This field contain the ‘ID Reference Code’ as indicated on message ‘enq’ from CIS
LEN =from 1 to 50 chars

MSG_PAGES
This field contain the number of pages to be print as indicated on message ‘enq’ from CIS (1,2 or 3)
LEN =1 char

MSG_END
Character Qualifier of ‘End Of Message’ (0x03 ASCII)
LEN =1 char (fixed)

CartonWrap CW1000 CIS Protocol release 2.3 – CMC confidential 26


MESSAGE ‘inv’ (response from CIS to CW1000)
This message contains the result of the invoice sent to laser
This message contains the result of the invoice sent to the laser (referred to Message
‘INV’) and must be send immediately to CW1000 (time out 1000 ms) to prevent timing
issues.
Please note, if CW1000 don’t receive the ‘inv’ message before the invoice has been
detected under the barcode reader (in general after 6..7 seconds from ‘INV’ message) ,
the box will be rejected due to ‘no ‘inv’ data from CIS.
NOTE:
The INVOICE CHANNEL is an option on the CW1000 ; if the CW1000 is not equipped with the INVOICE this
message will be ignored.

MESSAGE “inv”
CODE DESCRIPTION
MSG_START STX = 0x02
MSG_MACHINE_ID From 0 to 999999 (reply (reply the msg_machine_ID received on ‘INV’)
separator “|”
MSG_TYPE “inv” ( Fixed)
separator “|”
MSG_COUNTER From 1 to 999999 (reply the msg_counter received on ‘INV’)
separator “|”
MSG_REFERENCE REFERENCE FOR TRACKING (reply from msg_reference on ‘INV’)
separator “|”
MSG_RESULT 0=Error Printing 1=Sent correctly to printer
separator “|”
MSG_MATCH_INV REFERENCE FOR MATCHING ON INVOICE (max50 chars)
separator “|”
MSG_END ETX = 0x03

Example:
<stx>0001|inv|6|00ABCD|1||<etx>

MSG_START
Character Qualifier of ‘Start Of Message’ (0x02 ASCII)
LEN =1 char (fixed)

MSG_MACHINE_ID
Machine ID is the identification of the line involved by this message and is the reply from the INV message
received; this value will be compared with the own MachineID stored on the INI file.
Range=from 0 to 999999
LEN =from 1 to 6 chars

MSG_TYPE
Type of message : ‘inv’ (answer message)
LEN =3 char (fixed)

MSG_COUNTER
Message counter replied from message INV received
Range=from 1 to 999999
LEN =1 to 6 chars

CartonWrap CW1000 CIS Protocol release 2.3 – CMC confidential 27


MSG_REFERENCE
This field contain the ‘ID Reference Code’ as indicated on message ‘enq’ from CIS
LEN =from 1 to 50 chars

MSG_RESULT
This Flag will indicate if the Invoice as been sent correctly at the printer :
0=Error sending Data to the Laser Printer (this box will be rejected)
1=Invoice Data has been sent correctly
LEN =1 char

NOTE:
If CW1000 will receive the flag ‘0’ (error on sending Invoice), will stop the line and will display the related
error; the operator will make a purge of MTD4 and will restart.

MSG_MATCH_INV
After the Invoice Laser printer there is a barcode reader to read bar code (1D or 2D) printed on the top of
the invoice. This bar code will be compared with MSG_MATCH_INV to verify and validate the invoice.
If this string is empty the comparison will be skipped.
LEN =from 1 to 50 chars

NOTE:
To allow the matching reading, the barcode need to be readable on the invoice paper by the camera on top.

MSG_END
Character Qualifier of ‘End Of Message’ (0x03 ASCII)
LEN =1 char (fixed)

CartonWrap CW1000 CIS Protocol release 2.3 – CMC confidential 28


MESSAGE ‘LAB’ (from CW1000 to CIS)
This message contains the print request to thermal label printer at the end of the line.
This message is sent on the Rising edge of last photocell on machine just before labeler.

MESSAGE “LAB”
CODE DESCRIPTION
MSG_START STX = 0x02
MSG_MACHINE_ID From 0 to 999999 (from .INI)
separator “|”
MSG_TYPE “LAB” ( Fixed)
separator “|”
MSG_COUNTER From 1 to 999999
separator “|”
MSG_REFERENCE REFERENCE FOR TRACKING
separator “|”
MSG_STATUS 0=Bad/reject 1=Good box to be print
separator “|”
MSG_EVENT from 000 to 999 Event code in case of reject (see list)
separator “|”
MSG_SIZE H SIZE H of box in mm
separator “|”
MSG_SIZE L SIZE L of box in mm
separator “|”
MSG_SIZE W SIZE W of box in mm
separator “|”
MSG_AREA AREA OF CARTON USED for this box in mm^
separator “|”
MSG_WEIGHT_INSERTS ** WEIGHT OF INSERTS (as on HMI)
separator “|”
MSG_WEIGHT_CARTON ** WEIGHT OF CARTON USED FOR THIS BOX( calculated by CMC)
separator “|”
MSG_WEIGHT_SCALE ** GLOBAL WEIGHT OF BOX+ITEM returned by scale in grams
separator “|”
MSG_FEEDERS ** Feeders really activated on this box
separator “|”
MSG_END ETX = 0x03

** = Fields populated only if the related modules are installed on the CW1000.
Example:
<stx>0001|LAB|9|00ABCD|1|000|035|120|260|21200|20|50|250|11000000|<etx>

MSG_START
Character Qualifier of ‘Start Of Message’ (0x02 ASCII)
LEN =1 char (fixed)

MSG_MACHINE_ID
This Code Machine ID is the identification of the line stored on the internal .INI file and is sent at the e
beginning of all messages (from CW1000 to CIS and viceversa)
Range=from 0 to 999999
LEN =from 1 to 6 chars

CartonWrap CW1000 CIS Protocol release 2.3 – CMC confidential 29


MSG_TYPE
Type of message : ‘LAB’ (Labeler)
LEN =3 char (fixed)

MSG_COUNTER
Message counter increased of one unit by CW1000 every time a new message is sent to CSI
Range=from 1 to 999999
LEN =1 to 6 chars

MSG_REFERENCE
This field contain the ‘ID Reference Code’ as indicated on message ‘enq’ from CIS
LEN =from 1 to 50 chars

MSG_STATUS
This Flag indicate if the BOX has been produced correctly or not :
0=Error On this Box (will be rejected) – See MSG_EVENT with the reason of reject
1=BOX produced correctly
LEN =1 char

MSG_EVENT
This field indicate the event code related this box:
000=Box correct (no events)
001…999=Code of the event related this box (reason of reject) (see list below)
LEN =3 chars (fixed)

MSG_SIZE H
This field contain the values of size H of the box in mm
From 1 to max H

MSG_SIZE L
This field contain the values of size L of the box in mm
From 1 to max L

MSG_SIZE W
This field contain the values of size W of the box in mm
From 1 to max W

MSG_AREA
This field contain the values area of carton used to produce this box in square mm.
(this information can be usefully in case of calculation of weight of carton for this box)
From 1 to 9999999 mm^

CartonWrap CW1000 CIS Protocol release 2.3 – CMC confidential 30


MSG_WEIGHT_INSERTS
This field contain the sum of the weight of all inserts fed on the box.
This value is entered by the HMI by the operator (see pic)
Note: we sum values only if the feeder is enabled.
NOTE:
If the MTD4 (feeder option) is not installed on the CW1000 this field will be Zero.

MSG_WEIGHT_CARTON
This field contain the weight of the carton used on this box as detected by CMC
We obtain this value multiplying the CARTON_AREA x SPECIFIC_GRAVITY (set on the CMC HMI).

CartonWrap CW1000 CIS Protocol release 2.3 – CMC confidential 31


MSG_WEIGHT_ABSOLUTE
This field contain the global value of weight of the box as detected by check weight at the end of the line.
Value returned is based on Scale units setting and Scale communications protocol.
From 1 to 30000 grams
NOTE:
If the CHECKWEIGHT option is not installed on the CW1000 this field will be Zero.

MSG_FEEDERS
This field contain the result of the feeders activated on this box (forced or selective)
Each char will report the status of feeder
Example : ‘11000000’ means on this box has been fed INSERT1 and INSERT2
NOTE:
If the MTD4 (FEEDER MODULE) option is not installed on the CW1000 this field will be empty.

MSG_END
Character Qualifier of ‘End Of Message’ (0x03 ASCII)
LEN =1 char (fixed)

CartonWrap CW1000 CIS Protocol release 2.3 – CMC confidential 32


MESSAGE ‘lab’ (response from CIS to CW1000)
This message contains the answer at the Message ‘LAB’ and must be send immediately to
CW1000 (time out 500 ms) to prevent timing issues.
Please note, if CW1000 don’t receive the ‘lab’ message when the label has been detected
under the tamper (in general after 2..3 seconds from ‘LAB’ message) , the box will be
rejected due to ‘no ‘lab’ data from CIS’

MESSAGGIO “lab”
CODE DESCRIPTION
MSG_START STX = 0x02
MSG_MACHINE_ID From 0 to 999999 (reply (reply the msg_machine_ID received on ‘LAB’)
separator “|”
MSG_TYPE “lab” ( Fixed)
separator “|”
MSG_COUNTER From 1 to 999999 (reply the msg_counter received on ‘LAB’)
separator “|”
MSG_REFERENCE REFERENCE FOR TRACKING (reply the msg_reference on ‘LAB’)
separator “|”
MSG_RESULT 0=Error/not found label 1=Ok, sent to printer
separator “|”
MSG_MATCH_LAB String to be compare with Barcode on label (empy=no compare)
separator “|”
MSG_FLAG_TO_REJECT 0=Ok 1=Box to be reject (WRONG WEIGHT FROM YOUR CONTROLLER)
separator “|”
MSG_SORTER Number of the out gate on sorter (if installed)
separator “|”
MSG_END ETX = 0x03

Example:
<stx>0001|lab|9|00ABCD|1|MATCHABC|0|<etx>
MSG_START
Character Qualifier of ‘Start Of Message’ (0x02 ASCII)
LEN =1 char (fixed)

MSG_MACHINE_ID
Machine ID is the identification of the line involved by this message and is the reply from the LAB message
received; this value will be compared with the own MachineID stored on the INI file.
Range=from 0 to 999999
LEN =from 1 to 6 chars

MSG_TYPE
Type of message : ‘lab’ (result of label)
LEN =3 char (fixed)

MSG_COUNTER
Message counter replied from message LAB received
Range=from 1 to 999999
LEN =1 to 6 chars

CartonWrap CW1000 CIS Protocol release 2.3 – CMC confidential 33


MSG_REFERENCE
This field contain the ‘ID Reference Code’ as indicated on message ‘enq’ from CIS
LEN =from 1 to 50 chars

MSG_RESULT
This Flag will indicate if the Invoice as been sent correctly at the thermal printer :
0=Error sending Data to the Thermal Printer (box will be rejected)
1=Label Data sent correctly
LEN =1 char

MSG_MATCH_LAB
After the Labeler Thermal Printer there is a barcode reader to read bar code (1D or 2D) printed on the label.
This bar code will be compared with MSG_MATCH_LAB
If this string is empty after this point (this message) the comparison will be skipped.
NOTE:
This is the same field declared on ‘enq’ ; in fact you can choose to populated on ‘enq’ message or on ‘lab’
message as well.
In this way, CIS can define this barcode_reference later , ‘when’ send data to the labeler.
(supposing the barcode_match in not definable at the ‘enq’ level)
LEN =from 1 to 50 chars

MSG_FLAG_TO_REJECT
This Flag will indicate if the box NEED TO BE REJECTED due to the Wrong Weight
In fact, when CIS receive the ‘LAB’ message with all weight from the check weight, can decide if the weight
is valid or not based on the own CIS rules.

0=Good box
1=BAD BOX/To Reject for wrong weight
LEN =1 char

MSG_SORTER
This value will indicate the OUTPUT GATE at the end of the line where Box need to be diverted (from 1 to x)
Range=1 to x ( max number of OUTPUT GATE)
LEN=1 or 2 chars

NOTE:
If the number indicate is not valid (zero or over max) we will divert the box on the ‘default gate’ as on
setting of the machine
NOTE:
This sorter can be declared on the ‘enq’ message or on the ‘lab’ message; if declared on both, we use the
value declared on ‘lab’ message.
NOTE:
The SORTER is an option on the CW1000 ; if the CW1000 is not equipped with the SORTER this field should
be empty or Zero.

MSG_END
Character Qualifier of ‘End Of Message’ (0x03 ASCII)
LEN =1 char (fixed)

CartonWrap CW1000 CIS Protocol release 2.3 – CMC confidential 34


MESSAGE ‘END’ (from CW1000 to CIS)
This message contains the final result of the made box and it is sent after confirmation of
reading of the bar code on the label.

MESSAGE “END”
CODE DESCRIPTION
MSG_START STX = 0x02
MSG_MACHINE_ID From 0 to 999999 (from .INI)
separator “|”
MSG_TYPE “END” ( Fixed)
separator “|”
MSG_COUNTER From 1 to 999999
separator “|”
MSG_REFERENCE REFERENCE FOR TRACKING
separator “|”
MSG_STATUS 0=Bad/reject 1=Good box delivered on output belt
separator “|”
MSG_EVENT from 000 to 999 Event code in case of reject (see list)
separator “|”
MSG_SIZE H SIZE H of box in mm
separator “|”
MSG_SIZE L SIZE L of box in mm
separator “|”
MSG_SIZE W SIZE W of box in mm
separator “|”
MSG_AREA AREA OF CARTON USED for this box in mm^
separator “|”
MSG_WEIGHT_INSERTS ** WEIGHT OF INSERTS (as on HMI)
separator “|”
MSG_WEIGHT_CARTON ** WEIGHT OF CARTON USED FOR THIS BOX( calculated by CMC)
separator “|”
MSG_WEIGHT_SCALE ** GLOBAL WEIGHT OF BOX+ITEM returned by scale in grams
separator “|”
MSG_FEEDERS ** Feeders activated on this box
separator “|”
MSG_END ETX = 0x03

** = Fields populated only if the related modules are installed on the CW1000.
Example:
<stx>0001|END|009|00ABCD|1|000|035|120|260|21200|20|50|250|11000000|<etx>

NOTE:
The structure of this message is exactly the same of the ‘LAB’ message (see above)
but is updated with the final result.

CartonWrap CW1000 CIS Protocol release 2.3 – CMC confidential 35


MESSAGE ‘end’ (response from CIS to CW1000)
This message contains the answer at the Message ‘END’.
Not critical for timing point of view (used only to pair the message END)

MESSAGE “end”
CODE DESCRIPTION
MSG_START STX = 0x02
MSG_MACHINE_ID From 0 to 999999 (reply (reply the msg_machine_ID received on ‘END’)
separator “|”
MSG_TYPE “end” ( Fixed)
separator “|”
MSG_COUNTER From 1 to 999999 (reply the msg_counter received on ‘END’)
separator “|”
MSG_REFERENCE REFERENCE FOR TRACKING
separator “|”
MSG_END ETX = 0x03

Example:
<stx>0001|end|4|00ABCD|<etx>

MSG_START
Character Qualifier of ‘Start Of Message’ (0x02 ASCII)
LEN =1 char (fixed)

MSG_MACHINE_ID
Machine ID is the identification of the line involved by this message and is the reply from the END message
received; this value will be compared with the own MachineID stored on the INI file.
Range=from 0 to 999999
LEN =from 1 to 6 chars

MSG_TYPE
Type of message : ‘end’ (result of End)
LEN =3 char (fixed)

MSG_COUNTER
Message counter replied from message END received
Range=from 1 to 999999
LEN =1 to 6 chars

MSG_REFERENCE
This field contain the ‘ID Reference Code’ as indicated on message ‘enq’ from CIS
LEN =from 1 to 50 chars

MSG_END
Character Qualifier of ‘End Of Message’ (0x03 ASCII)
LEN =1 char (fixed)

CartonWrap CW1000 CIS Protocol release 2.3 – CMC confidential 36


MESSAGE ‘REM’ (from CW1000 to CIS)
This message will report the Reference ID of item/box removed from the line
This message is sent when the expected box on the exit is not detected:

Example:
If we detected box 1,2, -- 3,5 on output, the box 4 is missing (never detected at the end
of the line) and then CW1000 will send the related REM message.

MESSAGE “REM”
CODE DESCRIPTION
MSG_START STX = 0x02
MSG_MACHINE_ID From 0 to 999999 (from .INI)
separator “|”
MSG_TYPE “REM” ( Fixed)
separator “|”
MSG_COUNTER From 1 to 999999
separator “|”
MSG_REFERENCE REFERENCE FOR TRACKING
separator “|”
MSG_END ETX = 0x03

Example:
<stx>0001|REM|6|00ABCD|<etx>
MSG_START
Character Qualifier of ‘Start Of Message’ (0x02 ASCII)
LEN =1 char (fixed)

MSG_MACHINE_ID
This Code Machine ID is the identification of the line stored on the internal .INI file and is sent at the
beginning of all messages (from CW1000 to CIS and viceversa)
Range=from 0 to 999999
LEN =from 1 to 6 chars

MSG_TYPE
Type of message : ‘REM’ (Removed)
LEN =3 char (fixed)

MSG_COUNTER
Message counter increased of one unit by CW1000 every time a new message is sent to CSI
Range=from 1 to 999999
LEN =1 to 6 chars

MSG_REFERENCE
This field contain the ‘ID Reference Code’ as indicated on message ‘enq’ from CIS
LEN =from 1 to 50 chars

MSG_END
Character Qualifier of ‘End Of Message’ (0x03 ASCII)
LEN =1 char (fixed)

CartonWrap CW1000 CIS Protocol release 2.3 – CMC confidential 37


MESSAGE ‘rem’ (response from CIS to CW1000 )
This message contains the return ack at the message REM
Not critical time to answer (used only to pair the message ‘REM’)

MESSAGE “rem”
CODE DESCRIPTION
MSG_START STX = 0x02
MSG_MACHINE_ID From 0 to 999999 (reply (reply the msg_machine_ID received on ‘REM’)
separator “|”
MSG_TYPE “rem” ( Fixed)
separator “|”
MSG_COUNTER From 1 to 999999
separator “|”
MSG_REFERENCE REFERENCE FOR TRACKING
separator “|”
MSG_END ETX = 0x03

Example:
<stx>0001|rem|6|00ABCD|<etx>

MSG_START
Character Qualifier of ‘Start Of Message’ (0x02 ASCII)
LEN =1 char (fixed)

MSG_MACHINE_ID
Machine ID is the identification of the line involved by this message and is the reply from the REM message
received; this value will be compared with the own MachineID stored on the INI file.
Range=from 0 to 999999
LEN =from 1 to 6 chars

MSG_TYPE
Type of message : ‘rem’ (result of REMOVED)
LEN =3 char (fixed)

MSG_COUNTER
Message counter replied from message REM received
Range=from 1 to 999999
LEN =1 to 6 chars

MSG_REFERENCE
This field contain the ‘ID Reference Code’ as indicated on message ‘enq’ from CIS
LEN =from 1 to 50 chars

MSG_END
Character Qualifier of ‘End Of Message’ (0x03 ASCII)
LEN =1 char (fixed)

CartonWrap CW1000 CIS Protocol release 2.3 – CMC confidential 38


MESSAGE ‘HBT’ (from CW1000 to CIS and viceversa)
This ‘heartbeat’ message is used to verify and check the connection between systems.
The Heartbeat message can be started indifferently be CW1000 or CIS using the same
syntax “send HBT > receive hbt”.

MESSAGE “HBT”
CODE DESCRIPTION
MSG_START STX = 0x02
MSG_MACHINE_ID From 0 to 999999 (from .INI)
separator “|”
MSG_TYPE ‘HBT’ ( Fixed)
MSG_END ETX = 0x03

Example:
<stx>0001|HBT<etx>
MSG_START
Character Qualifier of ‘Start Of Message’ (0x02 ASCII)
LEN =1 char (fixed)

MSG_MACHINE_ID
This Code Machine ID is the identification of the line stored on the internal .INI file and is sent at the
beginning of all messages (from CW1000 to CIS and viceversa)
Range=from 0 to 999999
LEN =from 1 to 6 chars

MSG_TYPE
Type of message : ‘HBT’ (heartbeat)
LEN =3 char (fixed)

MSG_END
Character Qualifier of ‘End Of Message’ (0x03 ASCII)
LEN =1 char (fixed)

CartonWrap CW1000 CIS Protocol release 2.3 – CMC confidential 39


MESSAGE ‘hbt’ (from CIS to CW1000 or viceversa)
This message contains the answer at Message ‘HBT’ and must be send back immediately.
MESSAGE “hbt”
CODE DESCRIPTION
MSG_START STX = 0x02
MSG_MACHINE_ID From 0 to 999999 (reply (reply the msg_machine_ID received on ‘HBT’)
separator “|”
MSG_TYPE “hbt” ( Fixed)
MSG_END ETX = 0x03

Example:
<stx>0001|hbt<etx>
MSG_START
Character Qualifier of ‘Start Of Message’ (0x02 ASCII)
LEN =1 char (fixed)

MSG_MACHINE_ID
This Code Machine Id is the identification of the line and is stored on the internal .INI file and is sent at the
beginning of all messages (from CW1000 to CIS and viceversa)
Range=from 0 to 999999
LEN =from 1 to 6 chars

MSG_TYPE
Type of message : ‘hbt’ (result of heartbeat)
LEN =3 char (fixed)

MSG_END
Character Qualifier of ‘End Of Message’ (0x03 ASCII)
LEN =1 char (fixed)

CartonWrap CW1000 CIS Protocol release 2.3 – CMC confidential 40


MESSAGE ‘STS’ (from CIS to CW1000)
This message contains the Request of Status of the CW1000 and can be sent from CIS to
CW1000 at any time.

MESSAGE “STS”
CODE DESCRIPTION
MSG_START STX = 0x02
MSG_MACHINE_ID From 0 to 999999 (reply (reply the msg_machine_ID received on ‘ENQ’)
separator “|”
MSG_TYPE ‘STS’ ( Fixed)
MSG_END ETX = 0x03

Example:
<stx>0001|STS<etx>

MSG_START
Character Qualifier of ‘Start Of Message’ (0x02 ASCII)
LEN =1 char (fixed)

MSG_MACHINE_ID
Machine ID is the identification of the line involved by this message and is the reply from the ENQ message
received; this value will be compared with the own MachineID stored on the INI file.
Range=from 0 to 999999
LEN =from 1 to 6 chars

MSG_TYPE
Type of message : ‘STS’ (Status)
LEN =3 char (fixed)

MSG_END
Character Qualifier of ‘End Of Message’ (0x03 ASCII)
LEN =1 char (fixed)

CartonWrap CW1000 CIS Protocol release 2.3 – CMC confidential 41


MESSAGE ‘sts’ (from CW1000 to CIS)
This message contains the answer at ‘STS’ and contain the current status of CW1000.
This message is sent immediately after the request of message ‘STS’

MESSAGE “sts”
CODE DESCRIPTION
MSG_START STX = 0x02
MSG_MACHINE_ID From 0 to 999999 (from .INI)
separator “|”
MSG_TYPE “sts” ( Fixed)
separator “|”
MSG_RELEASE Release of Protocol (fixed ‘2’)
separator “|”
MSG_SUBRELEASE SubRelease of Protocol (fixed ‘3’)
separator “|”
MSG_GLOBALSTATUS 0=Stopped 1=Run 2=Pause 3=Error
separator “|”
MSG_ONLINE 0=OffLine 1=OnLine
separator “|”
MSG_END ETX = 0x03

Example:
<stx>0001|sts|2|2|0|1|<etx>

MSG_START
Character Qualifier of ‘Start Of Message’ (0x02 ASCII)
LEN =1 char (fixed)

MSG_MACHINE_ID
This Code Machine ID is the identification of the line stored on the internal .INI file and is sent at the
beginning of all messages (from CW1000 to CIS and viceversa)
Range=from 0 to 999999
LEN =from 1 to 6 chars

MSG_TYPE
Type of message : ‘sts’ (status)
LEN =3 char (fixed)

MSG_RELEASE
Number of Release of CMC protocol
FIXED = ‘2’

MSG_SUBRELEASE
Number of Sub Release of CMC protocol
FIXED = ‘3’

CartonWrap CW1000 CIS Protocol release 2.3 – CMC confidential 42


MSG_GLOBALSTATUS
Current status of CW1000
0 = Line Stopped
1 = Line Running
2 = Line in Pause
3 = Line in Error

MSG_ONLINE
CW1000 is OnLine or OffLine (Maintenance)
0 = OFFLINE
1 = ONLINE

MSG_END
Character Qualifier of ‘End Of Message’ (0x03 ASCII)
LEN =1 char (fixed)

CartonWrap CW1000 CIS Protocol release 2.3 – CMC confidential 43


LIST OF EVENTS
This is the list of event codes reported on message ‘LAB’ and ‘END’

000= GOOD PRODUCT !!


001=Main Barcode not present
002=Wrong ID from machine
003=Wrong Size H
004=Wrong Size L
005=Wrong Size W
006=Wrong Area (too big)
007=NoRead BClabel
008=BOXbarcode not present
009=Barcode or Reference not assigned!
010=Box Removed!
011=Error Matching BCLabel
012=Wrong Size on InFeed
013=Not received confirmation on InFeed
014=Label not sent correctly from CIS
015=Invalid Invoice parameter on Incoming item
016=NoRead MTD4 reader
017=Error Matching MTD4 reader
018=NoData from MTD4 reader
019=Forced Reject from customer (LAB message)
020=No answer on INV Message
021=No answer on LAB message
022=Invoice not sent correctly from CIS
023=not classified
024=not classified
025=not classified
..
100=Not classified
101=Product out of box
102=Flap anomaly
103=Inserting anomaly
104=Error flap on closing
105=Error ‘flag’ no coded
106= Not classified
..

CartonWrap CW1000 CIS Protocol release 2.3 – CMC confidential 44


DEVICES

BARCODE READER
To read the codes on Items on incoming section , CMC use as default an hand scanner
DATALOGIC PowerScan PD9530 able to read all common codes 1D or 2D on the market
(CODE128,EAN,UPC,DATAMATRIX etc)

CMC will offer the capability to install a camera ‘ON TOP’ (Datalogic Magellan vs3200)
located on the lateral side of loading area in order to read automatically all codes made in
evidence by operator.

For the verification of final label and for the verification of the Invoice (if required) and
the verification of the ColorPrint (if required) CMC will install a reader Datalogic Matrix
300N able to read all commons codes 1D and 2D.

CartonWrap CW1000 CIS Protocol release 2.3 – CMC confidential 45


INVOICE PRINTER (optional)
As printer for Invoice , if request , CMC install a Laser Printer type :

KYOCERA FS9350
port Ethernet

We use this printer with a fast Warm Up in order to reach the target speed of
1000 invoices/hours. In fact all common Laser Printers take time printing first copy
(warming time) and we can have delays during start /stop on machine.
As default the printer will print in ‘portrait’ A4 Face Up.
Optionally we can print ‘landscape’ A4 Face Up ; in this case, we need to install a special
device on CW1000 to ‘turn 90 deg’ the paper.
Optionally we can add a folder after the printer to create an A5 (one fold on middle)
Optionally we can accumulate up to 3 pages together
Different formats need to be evaluated changing some mechanical parts.
This printer is recommended to print up to 300.000 pages/mount

LABELLER
As labeler CMC install a Zebra thermal print head with Weber Applicator 4050 (or 5300
model for USA market):

ZEBRA model ZE500 4 inches


Resolution 300 DPI (200 DPI on request)
protocol ‘ZPL or ZPL II’
port Ethernet

The label format is from 100mm x 100mm to 100mm x 180mm (on printing direction);
please note, formats need to be defined in order to have the correct mechanical plates.
As standard, we supply 100mm x 150 mm

CartonWrap CW1000 CIS Protocol release 2.3 – CMC confidential 46


CHECK WEIGHT (optional)
As a scale, if request, CMC will install the following:

METTLER TOLEDO 40 ICS 469

Range from 0 to 30 Kg
Resolution 5 grams
Port Ethernet
Module contact Start/Stop

At the end of the line CMC will install a check weight to verify if the final box match the
weight of the Item inducted (+ weight of cardboard used to produces this box)

CW1000 will calculate the weight of the cardboard on box using the AREA_OF_BOX
multiplied by SPECIFIC_GRAVITY (grams/SqMeter)

CW1000 will track this weight along the line and will send to ‘CIS’ on the LAB message.

‘CIS’, when receive the LAB message, can decide if the global weight of the box is correct
or not and can send a FLAG TO REJECT BAD BOX to CW1000 (see ‘lab’ message).

CartonWrap CW1000 CIS Protocol release 2.3 – CMC confidential 47

You might also like