Download as pdf or txt
Download as pdf or txt
You are on page 1of 33

ESR Interfacing Manual

Ed. 1 Rev 6 - 2018-May-28

TEST1(*)
ROLLER 20 LC(*)
ROLLER 10 PN
ROLLER 20 PN
ROLLER 20 MC
INTERFACING MANUAL
(*)
Updated for Fw 8.00x

The disclosure of this document or parts of it, including but not limited to copying, reproduction and transmission in any form or by any
means, such as electronic, mechanical, photocopied, recorded, or otherwise, direct or indirectly, is prohibited without the prior written
authorization of Alifax S.r.l.

ESR D195.07.02 Rev. 06 ESR INTERFACING MANUAL Page: 1


ESR Interfacing Manual

Ed. 1 Rev 6 - 2018-May-28

REVISIONS

Revision Software Software


Software Software
n° Date ROLLER20 R20 MC Comments
TEST1 R20 PN
LC R10 PN
00 08/07/2005 4.05x 5.02 Creation

ROLLER10/20PN INTEGRATION
01 09/07/2008 601F 6.01C 1.00P INTERFACING LATEX
PROTOCOL

02 6.01x on 6.01x on Introduced R20-MC


15/01/2015 3.0x 4.0x
ward ward Corrected descriptive errors
03 6.01x on 6.01x on Split Roller20 in Roller20LC and
05/05/2016 3.0x 4.0x
ward ward Roller20PN and MC in Chapter 23
04 6.01x on 6.01x on
24/08/2016 3.0x 4.0x Corrected manufacturer name
ward ward
Introduced protocol BCI in TEST1
05 8.00x on 8.00x on
03/07/2017 3.0x 4.0x Removed protocol DAT 8 in TEST1
ward ward
and R20LC
06 8.00x on 8.00x on Highlighted tables with string length
28/05/2018 3.0x 4.0x
ward ward on query protoc0l

Manufacturer: ALIFAX S.r.l.

Production Site:
Via Merano 30 33045 Nimis (UD) Italy
Tel +39 0432 547454
Fax +39 0432 547378

Legal and Marketing Site:


via F. Petrarca 2
Isola dell'Abbà
35020 Polverara (PD)
Tel. +39-049-0992000
e-mail info@alifax.com
web www.alifax.com

ESR D195.07.02 Rev. 06 ESR INTERFACING MANUAL Page: 2


ESR Interfacing Manual

Ed. 1 Rev 6 - 2018-May-28

INDEX

1. INTRODUCTION------------------------------------------------------------------------------------------------------------------------------ 4
2. CABLES ---------------------------------------------------------------------------------------------------------------------------------------- 4
3. USEFUL TOOLS FOR DEBUGGING --------------------------------------------------------------------------------------------------- 4
4. SYMBOLS -------------------------------------------------------------------------------------------------------------------------------------- 4
5. TEST1 RS232 PORTS features: -------------------------------------------------------------------------------------------------------- 5
6. SERIAL CABLE PIN CONNECTIONS TO CONNECT TEST1 TO PC-LAB: ------------------------------------------------- 5
7. TEST1 protocol options up to Sw 6.51x --------------------------------------------------------------------------------------------- 6
8. RS232 test function to check the communication of TEST1 valid for Sw up to 6.51x ------------------------------- 8
9. TEST1 protocol options from Sw 8.00x on ward ------------------------------------------------------------------------------- 10
10. RS232 test function to check the communication of TEST1 from Sw 8.00x ------------------------------------------ 11
11. QUERY PROTOCOL for TEST1 up to Sw 6.51x --------------------------------------------------------------------------------- 12
12. QUERY PROTOCOL for TEST1 from Sw 8.00x ---------------------------------------------------------------------------------- 13
13. Query Protocol description valid for all TEST1 Sw: --------------------------------------------------------------------------- 14
14. ROLLER20 LC RS232 PORTS features: ------------------------------------------------------------------------------------------- 17
15. SERIAL CABLE PIN CONNECTIONS TO CONNECT ROLLER20 LC TO PC-LAB:------------------------------------ 17
16. ROLLER 20LC protocol options up to Sw 6.51x -------------------------------------------------------------------------------- 18
17. RS232 test function to check the communication of ROLLER20 LC ---------------------------------------------------- 18
18. QUERY PROTOCOL ROLLER20LC. ------------------------------------------------------------------------------------------------- 19
19. Protocol description: -------------------------------------------------------------------------------------------------------------------- 23
20. ROLLER 10 - 10PN - 20PN and R20MC RS232 PORTS features: --------------------------------------------------------- 25
21. SERIAL CABLE PIN CONNECTIONS TO CONNECT ROLLER INSTRUMENTS TO PC-LAB: --------------------- 25
22. ROLLER INSTRUMENTS PROTOCOL OPTIONS:------------------------------------------------------------------------------- 26
23. RS232 test to check the communication of ROLLER INSTRUMENTS -------------------------------------------------- 27
24. QUERY PROTOCOL for ROLLER INSTRUMENTS------------------------------------------------------------------------------ 28
25. Protocol explanation (BCI Configuration): --------------------------------------------------------------------------------------- 28
26. TEST1, ROLLER20LC and ROLLER INSTRUMENTS Multiple connections ----------------------------------------- 31
27. INTERFACING LATEX PROTOCOL -------------------------------------------------------------------------------------------------- 32

Note: The paragraphs written in blue characters (as on this note) indicate a variation or an addition to the
previous version of the manual.

We reserve the right to make changes in the course of technical development without previous notice.

ESR D195.07.02 Rev. 06 ESR INTERFACING MANUAL Page: 3


ESR Interfacing Manual

Ed. 1 Rev 6 - 2018-May-28

1. INTRODUCTION
This manual is focused to give detailed information about serial ports connections available on TEST1
ROLLER20LC, ROLLER10/10PN/20PN and ROLLER 20-MC instruments and communication protocol
features.
It should help Software House Companies during the modification or the installation of their program in the
Host Computer.

Please notice for easiness of explanations, we assume Roller10, Roller10PN, Roller20PN and Roller20MC from this
moment are referred as “Roller Instruments”

2. CABLES
A standard cable to connect two Personal Computers via serial port.
This cable must have:
D-type 25 pin female connector at one side and a D-type 9 pin female connector at the
opposite side for TEST1 and ROLLER20 (OLD MODEL).
D-type 9 pin female connector at one side and a D-type 9 pin female connector at the
opposite side for ROLLER10PN/20PN and R20-MC

3. USEFUL TOOLS FOR DEBUGGING


A PC computer with a communication program installed (like HyperTerminal of Windows) to test the
instrument communications.
HyperTerminal allows the technician to check the communication messages byte by byte.
To run it follow the path: start, all programs, accessories, communication, HyperTerminal; run it and
choose new connection. Type a preferred name e.g. TEST1, press OK and then EXIT.
Open the curtain menu pressing File on the left upper side of HyperTerminal window and Property; a new
window will be opened. Press Connection and choose the serial port where the serial cable has been
connected: e.g.Com1.
Press Configuration and choose the speed which should be 9600Bps. Press OK twice.

4. SYMBOLS
The below symbols will be displayed on HyperTerminal if the program is configured with Terminal character.

☻= STX symbol
♥ = ETX symbol
♠ = ACK symbol
§ = NAK symbol
CHECKSUM = XOR calculation of part of R received message to check the correctness of it.

ESR D195.07.02 Rev. 06 ESR INTERFACING MANUAL Page: 4


ESR Interfacing Manual

Ed. 1 Rev 6 - 2018-May-28

5. TEST1 RS232 PORTS features:

Communication ports parameters are fixed and cannot be modified.


Baud rate 9600
Parity N
Data bit number 8
Stop bit 1

HyperTerminal program must have the same parameters to a correct data exchanging.
PORT2 connection.

This instrument communicates through Serial Port 2. This


port uses a 25 pin male (DB25) serial connector. The used
pins are: no. 2 for TXDATA, no. 3 for RXDATA and 7 for
ground. The remaining pins are connected together as null-
modem configuration (4-5-8 and 6-20).

PORT1 connection

Serial Port 1 cannot be used for communication. It is connected


internally to the INTERNAL BAR CODE READER (IBCR – if installed)
or it can be connected to an EXTERNAL BAR CODE READER (EBCR)
The maximum number of ASCII characters for each
patient ID is 15 (fifteen).

6. SERIAL CABLE PIN CONNECTIONS TO CONNECT TEST1 TO PC-LAB:


DB9 F DB25 F
1 1
2 2
3 3
4 4
5 5
6 6
7 7
8 8
9 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

ESR D195.07.02 Rev. 06 ESR INTERFACING MANUAL Page: 5


ESR Interfacing Manual

Ed. 1 Rev 6 - 2018-May-28

7. TEST1 protocol options up to Sw 6.51x


The table below specify different configurations:

PROTOCOL Query DESCRIPTION R message structure SYMBOLS NOTES


DAT8 No Patient ID codes, STX
having length of
1 byte ☻ Checksum note
characters of 8
R 1 byte Checksum value is the result of
digits at Not used 2 byte Exclusive OR (XOR) of all
maximum, could Identification no 8 byte characters of the message,
be read by an Not used 6 byte excluded STX, ETX and
Checksum. If the Checksum value
external bar code ESR result 4 byte
calculated by the analyser is 03
reader (EBCR) Checksum 1 byte (corresponding to ETX), or 02
or they could be ETX
introduced typing
1 byte
♥ (corresponding to STX), or 00
(corresponding to NULL), the
them manually. value will be automatically
TOTAL = 24 byte
The output replaced with 7F hex value.
message Software House must adopt the
structure will be same procedure when
followed by the calculating checksum of the
sedimentation strings received from the
curve date (like analyser.
STD) if KINET
option in the
COMMUNICA-
TION menu is
enabled.

PROTOCOL Query DESCRIPTION R message structure SYMBOLS NOTES


DAT15 Yes It works by an
internal (IBCR)
STX
R
1 byte
1 byte
☻ Checksum note
Checksum value is the result of
or external bar Workstation Exclusive OR (XOR) of all
characters of the message,
code reader number 2 byte excluded STX, ETX and
(EBCR). It Identification no 15 byte Checksum. If the Checksum value
accepts the Rack no 2 byte calculated by the analyser is 03
maximum Position 2 byte (corresponding to ETX), or 02
patient identity Cycle/Bayer (Note) 2 byte ♥ (corresponding to STX), or 00
(corresponding to NULL), the
code with 15 ESR result 4 byte value will be automatically
characters of Checksum 1 byte replaced with 7F hex value.
length. This ETX 1 byte Software House must adopt the
same procedure when
protocol will be
calculating checksum of the
activated TOTAL = 31 byte strings received from the
automatically if analyser.
an IBCR is Bayer note:
connected. This field is managed by Bayer
parameter on tech/communication
Menu:
If Bayer is 0, the field deals with
the number of Cycle otherwise if
Bayer is 1, the field will contain
'01' (hex 30 and 31) to maintain
the Bayer protocol compatibility.

DAT8 either DAT15 option can be choice accessing in the COMMUNICATION MENU passing through
TECH MENU. Press key 5 from MAIN MENU and keys 1 and subsequently 9 as password and then key 3.
If the internal bar code reader is installed in a TEST1 instrument, DAT15 will be forced automatically at powering
on.

ESR D195.07.02 Rev. 06 ESR INTERFACING MANUAL Page: 6


ESR Interfacing Manual

Ed. 1 Rev 6 - 2018-May-28

In the TEST1 COMMUNICATION MENU, RS232 Protocol option can be recalled pressing key

1- DAT08 2- DAT15 This message will be displayed

Option (1) Enables the patient identification number length to 8 bytes.


Option (2) Enables the patient identification number length to15 bytes.

ESR D195.07.02 Rev. 06 ESR INTERFACING MANUAL Page: 7


ESR Interfacing Manual

Ed. 1 Rev 6 - 2018-May-28

8. RS232 test function to check the communication of TEST1 valid for Sw up to 6.51x
It simulates one transmission of 10 TEST1 results to host computer through RS232 serial port (SERIAL PORT 2).
If DAT8 is chosen, a message with 8 ID digits will be sent to the Host.
Selecting DAT15, the ID digit number to send to the Host is going to be 15.

DAT8 test transmission and its explanation:

Hex Length Description Note1:


Field name Symbol
value Checksum note
STX ☻ 02 1 char The first field is the same to all ten strings
Checksum value is the result of
„R‟ 52 1 char The second field is the same to all ten strings Exclusive OR (XOR) of all
Workstation The third field is the same to all ten strings characters of the message,
2 char
Number excluded STX, ETX and
Patient ID The furth field is different from the others strings Checksum. If the Checksum
8 char
Number value calculated by the analyser
Rack no. 2 char The fifth field is the same to all ten strings is 03 (corresponding to ETX), or
Position 2 char The sixth field is different from the others 02 (corresponding to STX), or 00
Bayer (Note2) 2 char The seventh field is the same to all ten strings (corresponding to NULL), the
Result 4 char The eighth field is different from the others value will be automatically
Checksum The nighth field is different from the others. replaced with 7F hex value.
1 char Software House must adopt the
(Note1)

ETX ♥ 03 1 char The tenth field is the same to all ten strings. same procedure
calculating checksum of the
when

Note : what above explained refers to the TEST strings received from the
Strings instrument send to host computer, this analyser.
string is displayed above this table.

Note2: Bayer field remains


activated to , '01' (hex 30 and 31)
because it is only a test.
Total length 24 char

DAT15 test transmission and its explanation:

Hex Length Description Note1:


Field name Symbol
value Checksum value is the result of
STX ( ☻ 02 1 char The first field is the same to all ten strings
Exclusive OR (XOR) of all
characters of the message,
„R‟ 52 1 char The second field is the same to all ten strings excluded STX, ETX and
Workstation The third field is the same to all ten strings Checksum. If the Checksum value
2 char
Number calculated by the analyser is 03
Patient ID The furth field is different from the others (corresponding to ETX), or 02
15 char
Number strings (corresponding to STX), or 00
Rack no. 2 char The fifth field is the same to all ten strings (corresponding to NULL), the
Position 2 char The sixth field is different from the others value will be automatically
Bayer (Note2) 2 char The seventh field is the same to all ten strings replaced with 7F hex value.
The eighth field is different from the others Software House must adopt the
Result 4 char
same procedure when
Checksum The nighth field is different from the others.
1 char calculating checksum of the
(Note1)
strings received from the
ETX ♥ 03 1 char The tenth field is the same to all ten strings.
analyser.
Note : what above explained refers to the TEST
Strings instrument send to host computer, this
string is displayed above this table. Note2: Bayer field remains activated
to , '01' (hex 30 and 31)
Total length 31 char

ESR D195.07.02 Rev. 06 ESR INTERFACING MANUAL Page: 8


ESR Interfacing Manual

Ed. 1 Rev 6 - 2018-May-28

In the COMMUNICATION MENU, RS232 function can be recalled pressing .

COMMUNICATION This message will be displayed


RS232 TEST TX

ESR D195.07.02 Rev. 06 ESR INTERFACING MANUAL Page: 9


ESR Interfacing Manual

Ed. 1 Rev 6 - 2018-May-28

9. TEST1 protocol options from Sw 8.00x on ward


Starting Sw 8.00x the option DAT 8 has been removed; option DAT15 has been changed to unidirectional mode
only and it has been introduced the option BCI which is the bidirectional mode in Query Host.

To be more clear the previously called “DAT 15” of Sw 6.51 which was acting in bidirectional mode, now have
been renamed as BCI.

Independently TEST1 is set on DAT 15 or BCI the protocol description for the result string ( R ) sent to HOST is
exactly the same.

Please notice that being TEST1 equipped with an Internal Bar Code Reader, the BCI protocol is automatically
forced, independently DAT15 is set.

If the customer is not interested in working with Query Host, leave instrument set on BCI mode and configure
ACK option set to OFF.

PROTOCOL Query DESCRIPTION R message structure SYMBOLS NOTES


DAT15
and
Yes It works by an
internal (IBCR)
STX
R
1 byte
1 byte
☻ Checksum note
Checksum value is the result of
or external bar Workstation Exclusive OR (XOR) of all
BCI characters of the message,
code reader number 2 byte excluded STX, ETX and
(EBCR). It Identification no 15 byte Checksum. If the Checksum value
accepts the Rack no 2 byte calculated by the analyser is 03
maximum Position 2 byte (corresponding to ETX), or 02
patient identity Cycle/Bayer (Note) 2 byte ♥ (corresponding to STX), or 00
(corresponding to NULL), the
code with 15 ESR result 4 byte value will be automatically
characters of Checksum 1 byte replaced with 7F hex value.
length. This ETX 1 byte Software House must adopt the
same procedure when
protocol will be
calculating checksum of the
activated TOTAL = 31 byte strings received from the
automatically if analyser.
an IBCR is Bayer note:
connected. This field is managed by Bayer
parameter on tech/communication
Menu:
If Bayer is 0, the field deals with
the number of Cycle otherwise if
Bayer is 1, the field will contain
'01' (hex 30 and 31) to maintain
the Bayer protocol compatibility.

DAT15 either BCI option can be choice accessing in the COMMUNICATION MENU passing through
TECH MENU. Press key 5 from MAIN MENU and keys 1 and subsequently 9 as password and then key 3.
If the internal bar code reader is installed in a TEST1 instrument, DAT15 will be forced automatically at powering
on.

In the TEST1 COMMUNICATION MENU, RS232 Protocol option can be recalled pressing key

1- DAT15 2- BCI This message will be displayed

Option (1) Enables the patient identification number length to 15 bytes unidirectional.
Option (2) Enables the patient identification number length to15 bytes but it enables the Query Host Mode

Please notice that being TEST1 equipped with an Internal Bar Code Reader, the BCI protocol is automatically
forced, independently DAT15 is set.

ESR D195.07.02 Rev. 06 ESR INTERFACING MANUAL Page: 10


ESR Interfacing Manual

Ed. 1 Rev 6 - 2018-May-28

10. RS232 test function to check the communication of TEST1 from Sw 8.00x
It simulates one transmission of 10 TEST1 results to host computer through RS232 serial port (SERIAL PORT 2).
DAT15 and BCI test transmission and its explanation:

Hex Length Description Note1:


Field name Symbol
value Checksum value is the result of
STX ( ☻ 02 1 char The first field is the same to all ten strings
Exclusive OR (XOR) of all
characters of the message,
„R‟ 52 1 char The second field is the same to all ten strings excluded STX, ETX and
Workstation The third field is the same to all ten strings Checksum. If the Checksum value
2 char
Number calculated by the analyser is 03
Patient ID The furth field is different from the others (corresponding to ETX), or 02
15 char
Number strings (corresponding to STX), or 00
Rack no. 2 char The fifth field is the same to all ten strings (corresponding to NULL), the
Position 2 char The sixth field is different from the others value will be automatically
Bayer (Note2) 2 char The seventh field is the same to all ten strings replaced with 7F hex value.
The eighth field is different from the others Software House must adopt the
Result 4 char
same procedure when
Checksum The nighth field is different from the others.
1 char calculating checksum of the
(Note1)
strings received from the
ETX ♥ 03 1 char The tenth field is the same to all ten strings.
analyser.
Note : what above explained refers to the TEST
Strings instrument send to host computer, this
string is displayed above this table. Note2: Bayer field remains activated
to , '01' (hex 30 and 31)
Total length 31 char

In the COMMUNICATION MENU, RS232 function can be recalled pressing .

COMMUNICATION This message will be displayed


RS232 TEST TX

ESR D195.07.02 Rev. 06 ESR INTERFACING MANUAL Page: 11


ESR Interfacing Manual

Ed. 1 Rev 6 - 2018-May-28

11. QUERY PROTOCOL for TEST1 up to Sw 6.51x


This document describes the serial protocol (Query Protocol) used by TEST1 with the Internal Bar Code
Reader (IBCR). It queries HOST Computer through Serial Port 2 (RS232C).

TEST1 Settings for a correct communication

COMMUNICATION MENU in the TECH MENU, allows the configuration of some parameters for the correct communication
protocol. The accessing in it is allowed by typing key 5 from MAIN MENU, keys 1 and subsequently 9 for the password
requesting and key 3.

The configuration for a correct Query protocol functioning is:

RS232 PROTOCOL= It has to be set to DAT15 (Working with an Internal Bar Code Reader it is forced automatically).
To access inside and select DAT15 press key 1 in the COMMUNICATION menu.

KINET. SETUP= this option must remain set to 0

CHANGE ID= this option must remain set to 0.

SETUP [ * ]= Press key 4 in the COMMUNICATION menu to access inside the option and 1 to enable the
asterisk character transmission to the host. It works when a analysed sample gives a low value of
hematocrit .

ENABLE BAYER Press key 5 in the COMMUNICATION menu to access Bayer option and 1 to enable it to
guarantee the Bayer protocol specifications (field Cycle/Bayer = 01).
If Bayer protocol is not requested this option must be kept to 0 (disable).

MEASURE MISSING ID= Press key 6 in the COMMUNICATION menu to access to the option and key 1 to allow the
analysis of samples with an auto generated ID in case IBCR is not able to read the barcode label.
Keeping it to 0, these samples won‟t be analysed.

TIME OUT UART= Press key 7 in the COMMUNICATION menu to access this option to set the waiting time (from 2 to
99 seconds) if the increasing of the waiting time to receive “T” message and the confirmation byte
(ACK) for having received “R” message is requested. The maximum time to receiving “T” message
and the confirmation byte (ACK) for having received “R” message remain set to 2 seconds keeping
it to OFF. If within this time no message comes in, the instrument will go ahead. This option works
if ACK option, COMMUNICATION menu is enabled.

TEST1 NUMBER= A number between 01 to 99 on each instrument can be assigned by this option if multiple
instruments connections to Host computer is required
Notice: following parameters MUST BE ALWAYS DISABLED: Change ID, Send ESR Limits, Send 6 Par, Send Curve
Parameters and VS

ESR D195.07.02 Rev. 06 ESR INTERFACING MANUAL Page: 12


ESR Interfacing Manual

Ed. 1 Rev 6 - 2018-May-28

12. QUERY PROTOCOL for TEST1 from Sw 8.00x


This document describes the serial protocol (Query Protocol) used by TEST1 with the Internal Bar Code
Reader (IBCR). It queries HOST Computer through Serial Port 2 (RS232C).
Please notice that being TEST1 equipped with an Internal Bar Code Reader, the BCI protocol is automatically
forced, independently DAT15 is set.

Messages.

„Q‟ message from TEST1 „T‟ message from HOST „R‟ message from TEST1

Lengt
Field Hex Lengt Field Hex Lengt Hex
Field name h
name value h name value h value

STX (note 3) 02 1 char STX (note


02 1 char STX (note 3) 02 1 char
3)
„Q‟ 51 1 char „T‟ 54 1 char „R‟ 52 1 char
Workstatio
Workstation Workstation
2 char n 2 char 2 char
number Number
Number
Patient ID 15 Patient ID 15 Patient ID 15
number char Number char Number char
Result 4 char Result 4 char Rack no. 2 char
(note
Checksum (note 1) 1 char Checksum 1)
1 char Position 2 char
ETX (note 3) 03 1 char ETX (note
03 1 char Cycle/Bayer (note 2) 2 char
3)
Result 4 char
25 25
Total length Total length Checksum (note 1) 1 char
char char
ETX (note 3) 03 1 char

31
Total length
char

Note 1: Checksum value is the result of Exclusive OR (XOR) of all characters of the message, excluded STX, ETX and
Checksum. If the Checksum value is 03 (corresponding to ETX), 02 (corresponding to STX), 00 (corresponding to
NULL), the value will be replaced with 7F hex value. The software house should take into account these references
and modify its program to adapt such requisition. From software version 6.51E onwards, in the transmission protocol,
hexadecimal characters like 0x13 (DC3 character), 0x14 (DC4 character), and 0x17 (ETB character), are not
transmitted unless used as checksum

Note 2: From the 4.02E to 4.03J software versions, this field take care of the Cycle number. From the 4.03K onwards, this field
could be relating to Bayer parameter setting it by software. If Bayer is 0, the field deals with the number of Cycle
otherwise if Bayer is 1, the field should contain '01' (hex 30 and 31) to maintain the Bayer protocol compatibility.

ESR D195.07.02 Rev. 06 ESR INTERFACING MANUAL Page: 13


ESR Interfacing Manual

Ed. 1 Rev 6 - 2018-May-28

Note 3: <STX> character ( ☻symbol looking at the hyper terminal program) in the serial transmission is represented by
0x02 hexadecimal bytes and <ETX> ( ♥ symbol looking at the hyper terminal program) by 0x03.

TEST1 Settings for a correct communication

COMMUNICATION MENU in the TECH MENU, allows the configuration of some parameters for the correct communication
protocol. The accessing in it is allowed by typing key 5 from MAIN MENU, keys 1 and subsequently 9 for the password
requesting and key 3.

The configuration for a correct Query protocol functioning is:

RS232 PROTOCOL= It has to be set to BCI (Working with an Internal Bar Code Reader it is forced automatically).
To access inside and select BCI press key 1 in the COMMUNICATION menu.

KINET. SETUP= this option must remain set to 0.

CHANGE ID= this option must remain set to 0.

SETUP [ * ]= Press key 4 in the COMMUNICATION menu to access inside the option and 1 to enable the
asterisk character transmission to the host. It works when a analysed sample gives a low value of
hematocrit .

ENABLE BAYER Press key 5 in the COMMUNICATION menu to access Bayer option and 1 to enable it to
guarantee the Bayer protocol specifications (field Cycle/Bayer = 01).
If Bayer protocol is not requested this option must be kept to 0 (disable).

MEASURE MISSING ID= Press key 6 in the COMMUNICATION menu to access to the option and key 1 to allow the
analysis of samples with an auto generated ID in case IBCR is not able to read the barcode label.
Keeping it to 0, these samples won‟t be analysed.

TIME OUT UART= Press key 7 in the COMMUNICATION menu to access this option to set the waiting time (from 2 to
99 seconds) if the increasing of the waiting time to receive “T” message and the confirmation byte
(ACK) for having received “R” message is requested. The maximum time to receiving “T” message
and the confirmation byte (ACK) for having received “R” message remain set to 2 seconds keeping
it to OFF. If within this time no message comes in, the instrument will go ahead. This option works
if ACK option, COMMUNICATION menu is enabled.

TEST1 NUMBER= A number between 01 to 99 on each instrument can be assigned by this option if multiple
instruments connections to Host computer is required
Notice: following parameters MUST BE ALWAYS DISABLED: Change ID, Send ESR Limits, Send 6 Par, Send Curve
Parameters and VS

13. Query Protocol description valid for all TEST1 Sw:


Following protocol is the same independently it is set the option DAT 15 for Sw up to 6.51x or BCI from Sw
8.00X on ward.
Please notice that from Sw 8.00x on ward being TEST1 equipped with an Internal Bar Code Reader, the option
BCI is automatically forced even if the option DAT15 is configured. This change does not affect in any way the
working mode of the Query Host Protocol.
1. The internal Scanner reads the bar code (patient ID) from the label stuck on the tube, the instrument creates
“Q” message and sends it to HOST computer through RS232
serial port (or to PC LAB PC if it is connected like a bridge). <STX>Q01123456789 0000a<ETX>

2. HOST computer verifies if the patient identity code is present in the working list and, accordingly, it replies with
"T" message. TEST1 waits to receiving it within two seconds and then it goes ahead.

ESR D195.07.02 Rev. 06 ESR INTERFACING MANUAL Page: 14


ESR Interfacing Manual

Ed. 1 Rev 6 - 2018-May-28

If ACK option is off, TEST1 is going to remain waiting up to 2 seconds for receiving it, otherwise if it is on,
TEST1 is going to wait for all the set time (TIMEOUT from 2 to 99 seconds).

TIMEOUT UART time and ACK are selectable in the COMMUNICATION MENU.

“T” message is going to have the result field filled with “0001”, if
<STX>T01123456789 0001e<ETX>
the sample requires the analysis. The result field will be filled with
“0000” if the sample doesn‟t require the analysis.
<STX>T01123456789 0000d<ETX>

3. After measuring (24 seconds about), TEST1 sends “R”


message to host replacing the result field value (0001) <STX>R01123456789 0103050012f <ETX>
with the ESR read value which should be between 0002
and 0120 or negative.
Errors messages are reported like: -001 for SM (Sample <STX>R01123456789 010305-004l <ETX>
Missing) error, -002 for NR (Not Readable) error and
-004 for NF (No flow) error.

4. Host computer should send ACK confirmation byte (♠ symbol displayed on the HyperTerminal program) to
TEST1 for having accepted “R” message. TEST1 will ignore it, if ACK is off. Otherwise it will wait for all the set
time (TIMEOUT from 2 to 99 seconds) if ACK is On.
ACK = Hexadecimal code 06

Warnings:
1 If a patient identity (ID) read by the TEST1 Scanner doesn‟t find its own correspondent code in the Host
computer working list, “T” message will be replaced by <NAK> message (NAK Message) Hex code 21
(§ symbol displayed on the HyperTerminal program). The sample will be
however analysed and “R” message sent to host.

2 If a particular sample has a very low hematocrit (around 20% and less) and * option in the communication
menu is enabled, the result field of “R” message, sent
to the host, will contains an asterisk set in the first <STX>R01123456789 010305*015[ <ETX>
position on the left and its own ESR result
(i.e.
If the analysis of a particular sample generates an error and * option in the communication menu is enabled,
ESR result field will contain 0 in the first left position,
“-“ (minus) in the second and the error code (i.e. <STX>R01123456789 0103050-04\ <ETX>

3 If the internal Scanner cannot read the patient ID and “MISS ID” option in the Communication setup is 0,
“Q” message won‟t be created. The sample without its own patient identity won‟t be processed.

ESR D195.07.02 Rev. 06 ESR INTERFACING MANUAL Page: 15


ESR Interfacing Manual

Ed. 1 Rev 6 - 2018-May-28

4 If the internal Scanner cannot read the patient ID and “MISS ID” option in the Communication setup is 1,
“Q” message won‟t be created. The sample without its own patient identity will be, however, processed and
“R” message sent to host with an identity code generated by the instrument itself.
The new patient ID, in this case, will be composed by 10 characters: cycle number (from 01 to 99)
(2 characters), instrument s/n (4 characters), rack number (from 01 to 04- 2 characters) sample position in
the rack (from 01 to 15- 2 characters).

Example:

Instrument s/n Rack number

0307920106

Cycle number Sample position in the rack

A complete “R” string for the transmission could be:

[Workstation number] [Instrument s/n] [Rack number] [ESR] [Checksum]

<STX>R010307920106 0106030012f <ETX>

[Cycle number] [Sample position] [Cycle number (Note 2)]

ESR D195.07.02 Rev. 06 ESR INTERFACING MANUAL Page: 16


ESR Interfacing Manual

Ed. 1 Rev 6 - 2018-May-28

14. ROLLER20 LC RS232 PORTS features:

Communication ports parameters are fixed and cannot be modified.


Baud rate 9600
Parity N
Data bit number 8
Stop bit 1

HyperTerminal program must have the same parameters to a correct data exchanging.
PORT2 connection.

This instrument communicates to host through Serial Port 2.This


port uses a 25 pin male (DB25) serial connector and the used
pins are: no. 2 for TXDATA, no. 3 for RXDATA and 7 for ground.
The remaining pins are connected together as null-modem
configuration (4-5-8 and 6-20).

PORT1 connection.

Serial Port 1 has been reserved for the connection of an


external SCANNER The maximum number of ASCII
characters for each patient ID is 15 (fifteen).

15. SERIAL CABLE PIN CONNECTIONS TO CONNECT ROLLER20 LC TO PC-LAB:


The configuration port is the same as for TEST1,please refer to chapter 6

ESR D195.07.02 Rev. 06 ESR INTERFACING MANUAL Page: 17


ESR Interfacing Manual

Ed. 1 Rev 6 - 2018-May-28

16. ROLLER 20LC protocol options up to Sw 6.51x

The table below specify the different configurations:

PROTOCOL Query DESCRIPTION R message structure SYMBOLS NOTES


BCI Yes It works by an
internal (IBCR) or
STX
R
1 byte
1 byte
☻ Checksum note:
Checksum value is the result
external bar code of Exclusive OR (XOR) of all
Workstation number characters of the message,
reader (EBCR). It
2 byte excluded STX, ETX and
accepts up to 15
Identification n 15 byte Checksum. If the Checksum
characters of value calculated by the
maximum patient Rack number 2 byte
analyser is 03 (corresponding
identity code. The Position 2 byte to ETX), or 02 (corresponding
Cycle/Bayer 2 byte
instrument enables
Query protocol ESR result 4 byte ♥ to STX), or 00 (corresponding
to NULL), the value will be
which enquires the Checksum 1 byte automatically replaced with 7F
host if a specific hex value.
ETX 1 byte
sample needs to be Software House must adopt
TOTAL = 31 byte the same procedure when
analysed or not.
calculating checksum of the
strings received from the
analyser.

Bayer note: This field is


managed by Bayer parameter
on Tech Menu.
If Bayer is 0, the field deals
with the number of Cycle
otherwise if Bayer is 1, the
field will contain '01' (hex 30
and 31) to maintain the Bayer
protocol compatibility.

STD, DAT8 DAT15 or BCI protocol can be selected by software accessing in the SETUP menu.

In the SETUP MENU list, RS232 Protocol can be recalled by pressing or until the following
message is displayed:

SETUP
RS232 PROTOCOL Confirm the function by pressing

The following menu will be displayed:

1 - STD 2 - DAT08
3 - DAT15 4 – BCI

17. RS232 test function to check the communication of ROLLER20 LC


It simulates one test transmission of 10 test results to host computer through RS232 serial port (SERIAL PORT 2).
If DAT8 is chosen, a message with 8 ID digits will be sent to the Host.
Selecting DAT15 or BCI, the ID digit number to send to the Host is going to be 15.

The DAT8 and DAT 15 test stings sent out from R20LC are the same sent out from TEST1, please refer to chapter
8

ESR D195.07.02 Rev. 06 ESR INTERFACING MANUAL Page: 18


ESR Interfacing Manual

Ed. 1 Rev 6 - 2018-May-28

In the TECH MENU, RS232 function can be recalled pressing or for many times until the
following message is displayed.
COMMUNICATION
RS232 TEST TX Press to run the test

18. QUERY PROTOCOL ROLLER20LC.


This paragraph describes the serial protocol (Query Protocol) used by ROLLER20 with an External Bar
Code Reader (EBCR) connected to Serial Port 2 (RS232C).

Settings for a Query protocol correct communication on ROLLER20

The configuration for a correct Query protocol functioning is:

RS232 PROTOCOL= It must be set to BCI (And an External Bar Code Reader must be installed).

This function is available in the SETUP MENU. It can be recalled by pressing or

until the following message is displayed:

SETUP
RS232 PROTOCOL
Confirm the function by pressing

The following menu will be displayed:

1 - DAT15 2 – BCI _ Make your choice and press CLEAR


twice to go back MAIN MENU

Chose 2 for a Query correct communication:

ESR D195.07.02 Rev. 06 ESR INTERFACING MANUAL Page: 19


ESR Interfacing Manual

Ed. 1 Rev 6 - 2018-May-28

KINET. SETUP= This function is available in the SETUP MENU. It can be recalled by pressing or

until the following message is displayed:

SETUP
KINET. SETUP Confirm the function by pressing

The following message will be displayed:

KINET. SETUP= 0
1 -Y 0-N _
It must be set to 0

SETUP [ * ]= This function is available in the TECH MENU. It can be recalled by pressing or

until the following message is displayed:

TEC. CAL MENU 19


[ * ] SETUP Confirm the function by pressing

The following message will be displayed:

1- [ * ] [Y]
0- [ * ] [N]

The asterisk function activated allows the instrument to send the asterisk parameter to the
Host computer through the serial port. It will be displayed near the ESR value if the
sample analyzed has a haematocrit value low (< 20%).

IDENTITY ESR
Example of ESR result (045) with the * parameter enabled
and sent to the host computer with the patient identification
2367483493 *045 together.

IDENTITY ESR
Example of a sample analysed with a haematocrit value over
20% and * parameter enabled. The ESR result (5) will be
2367483493 0-05 sent to the host computer using this form.

Note:
Having disabled the asterisk function, the instrument cannot send the asterisk character to the host if the analysed
sample had a low haematocrit value, but it will be printed out next the ESR result however.

ESR D195.07.02 Rev. 06 ESR INTERFACING MANUAL Page: 20


ESR Interfacing Manual

Ed. 1 Rev 6 - 2018-May-28

ENABLE BAYER Bayer communication protocol detects the Bayer field value (the previous field of the
ESR result) in the “R” message. If Bayer function in the COMMUNICATION menu is
enabled, the field will contain '01' (hex 30 and 31) to maintain the Bayer protocol
compatibility otherwise if it is disabled, the field will report the number of Cycle.

This function is available in the TECH MENU. It can be recalled by pressing or

until the following message is displayed:

TEC. CAL MENU 7


ENABLE BAYER Confirm the function by pressing

The following message will be displayed:

1- ENABLE [Y]
0- DISABLE [N]

Query setup= This function is available in the TECH MENU. It can be recalled by pressing or

until the following message is displayed:

TEC. CAL MENU 17


QUERY SETUP
Confirm the function by pressing
The following message will be displayed:

1- Query [Y]
0- Query [N]

If Query is enabled (default), the instrument will be able to interrogate the Host computer
for the analysis requesting of each specific sample.

ACK= This function is available in the TECH MENU. It can be recalled by pressing or

until the following message is displayed:

TEC.CAL MENU 18
ACK SETUP Confirm the function by pressing

The following message will be displayed:

1 ACK [Y]
0 ACK [N]

ESR D195.07.02 Rev. 06 ESR INTERFACING MANUAL Page: 21


ESR Interfacing Manual

Ed. 1 Rev 6 - 2018-May-28

This function allows to extend the waiting time for receiving “T” message (Query answer from the HOST computer)
and ACK (acknowledge message confirmation from the HOST computer for having received “R” message). To
modify the extension time (in seconds), it is available the TIMEOUT function explained in the Protocol description.

Notice: following parameters MUST BE ALWAYS DISABLED: Send ESR Limits, Send 6 Par, Send Curve Parameters
and VS

Parameters verification:

In the SETUP menu you will find FLAG LIST function. Press or until the following message is
displayed:

SETUP
FLAGS LIST
Confirm the function by pressing

Below is an example

ROLLER 20
UK ver. 6.xx
ROLLER20 SN. xxx
# AVAILABILITY xxxx
# GLOBAL COUNT. xxxx
GAIN 1.0000
MIXING CYCLES 180
MIXING SPEED 1
RS232 BCI
FLOW CONT. ON
OFFSET LEV. FLOW 800
OT OFFSET LEV. 700
T. 100 974
ROLLER n. 1
ACK setup 0
Query setup 1
Print setup 1
Calib. setup 1
Bayer. setup 1
[ * ] setup 0
Kinet.setup 0
Offset nee. 0
Vs 0
TimeOut 20
Warning SMART 1000

ESR D195.07.02 Rev. 06 ESR INTERFACING MANUAL Page: 22


ESR Interfacing Manual

Ed. 1 Rev 6 - 2018-May-28

19. Protocol description:


1. The patient bar code ID stuck on each sample tube can be
read by using of an External Bar Code Reader connected at <STX>Q01123456789 0000a<ETX>
the ROLLER Serial Port1. The instrument will create and send
“Q” message to the HOST computer through RS232 serial port (or to LAB PC if used like a bridge) if Query
Setup option is 1. (Note 1)

2. HOST computer will verify if the patient identity has been inserted in the working list and then it replies with
"T" message.
If ACK option (in the TECH MENU list) is 0, ROLLER 20 remains waiting up to 2 seconds for receiving it.
otherwise if ACK option is 1 it will wait for all the set time (TIMEOUT from 2 to 99 seconds).

TIMEOUT UART time option is located in the TECH MENU list. (Note 2)

As soon as the instrument receives “T” message, it will be checked.


The wheel will rotate to one position to allow the operator to
insert the sample tube, if “T” message has the result field <STX>T01123456789 0001e<ETX>
compiled with “0001” (that means the sample requires the
analysis). The wheel remains stopped, if the result field will be <STX>T01123456789 0000d<ETX>
“0000” (the analysis of that particular sample is not requested).

th
The procedure above explained will be repeated for the first to the 18 sample tubes before starting
the analysis.

3. After measuring (20 seconds about), ROLLER 20 will


<STX>R01123456789 0103050012F <ETX>
compile “R” messages replacing the result field value
(0001) with an ESR value between values of 0002 and
0120 or a negative one. For reading errors, the
instrument will report the error codes like: -001 for SM <STX>R01123456789 010305-004\ <ETX>
error, -002 for NR error and -004 for NF error.


4. Host computer should send an ACK confirmation byte ( symbol on hyper ACK Hex 06
terminal program) to ROLLER 20 for having accepted “R” message. The
instrument will ignore it, if ACK option is 0.
It will wait for all the set time (TIMEOUT from 2 to 99 seconds) if ACK option is 1.

Warnings:
1. If the patient identity (ID) read by the Scanner doesn‟t find its own correspondent in the Host computer
working list, “T” message will be replaced by <NAK> message Hexadecimal code 21
(§ symbol on hyper terminal program), the wheel will however rotate to the next
position to allow the operator to insert the tube. The sample will be analysed and “R” message sent to host.
2. If a particular sample has a very low haematocrit (less then 20%) and * option in the TECH MENU is
enabled, the result field of “R” message sent to the host will be composed by an asterisk in the first position
on the left and the rest its own ESR result (i.e. “ *015 ”).
If the analysis of a particular sample generates an error, ESR result field will have 0 in the first left position
“-“ (minus) for the second position and the rest of the field the error code (i.e. “ 0-04 “).

ESR D195.07.02 Rev. 06 ESR INTERFACING MANUAL Page: 23


ESR Interfacing Manual

Ed. 1 Rev 6 - 2018-May-28

3. If no label has been stuck on the tube or the external Scanner cannot read the patient ID, “Q”
message won‟t be created. The wheel will rotate to accept the sample by pressing ENTER key
The sample will be however processed and “R” message sent to host with an identity code
generated by itself.
The new patient ID in this case will be composed by 10 characters:
cycle number (2 characters from 01 to 99), instrument s/n (4 characters), wheel number ( 2 characters)
sample position in the wheel (from 01 to 18- 2 characters).

Example:
Instrument s/n Wheel number

0307920106

Cycle number Sample position in the wheel

A complete “R” string for the transmission will be:

[Workstation number] [Instrument s/n] [Wheel number] [ESR] [Checksum]

<STX>R010307920106 0106030012I <ETX>

[Cycle number] [Sample position] [Cycle number (Note 3)]

Note 1: If Query Setup option is 0, no Query protocol will be created; the instrument is going to accept and analyse all
samples.

Note 2: Follow the instruction looking at the Chapter 13-8 of the technical manual for TIMEOUT UART activation.

Note 3: This field is related to Bayer parameter on SETUP. If Bayer is 0, the field contains the number of Cycle. If Bayer is 1,
the field contains '01' (hex 30 and 31) to keep compatibility with Bayer protocol.

Note 4: Checksum value is the result of Exclusive OR (XOR) of all characters of the message, excluded STX, ETX and
Checksum. If the Checksum value calculated by the analyser is 03 (corresponding to ETX), or 02 (corresponding to
STX), or 00 (corresponding to NULL), the value will be automatically replaced with 7F hex value.
Software House must adopt the same procedure when calculating checksum of the strings received from the
analyser.

ESR D195.07.02 Rev. 06 ESR INTERFACING MANUAL Page: 24


ESR Interfacing Manual

Ed. 1 Rev 6 - 2018-May-28

20. ROLLER 10 - 10PN - 20PN and R20MC RS232 PORTS features:


Please notice for easiness of explanations, we assume Roller10, Roller10PN, Roller20PN and Roller20MC from this
moment are referred as “Roller Instruments”

PORT2 connection.

The instrument communicates through Serial Port 1.This port


uses a 9 pin male (DB9) serial connector.

The used pins are: n° 2 for TXDATA, n° 3 for RXDATA and 5


for ground. The remaining pins are connected together as null-
modem configuration.

This cable must have a D-type 9 pin female connector from


one side and a D-type 9 pin female connector at the opposite
side.

PORT1 connection

Serial Port 1 has been reserved for the connection of an


external SCANNER The maximum number of ASCII
characters for each patient ID is 15 (fifteen).

21. SERIAL CABLE PIN CONNECTIONS TO CONNECT ROLLER INSTRUMENTS TO PC-LAB:


DB9 F DB9 F
1 1
2 2
3 3
4 4
5 5
6 6
7 7
8 8
9 9

ESR D195.07.02 Rev. 06 ESR INTERFACING MANUAL Page: 25


ESR Interfacing Manual

Ed. 1 Rev 6 - 2018-May-28

22. ROLLER INSTRUMENTS PROTOCOL OPTIONS:


The choice of the protocol enables the Query functionality.
Patient ID codes, having length of characters of 8 digits at maximum, could be read by an external bar code reader (EBCR) or they could be
introduced typing them manually.

The tables below specify different configurations:

DAT8 Result transmission string:


Checksum note:
Field name Symbol Hex value Length Description
See note at the end of this
STX ☻ 02 1 char Start transmission
page

„R‟ 52 1 char R states for result message Note2: Bayer field is not used, in
Workstation Is the number identifying the instrument if more than this case show s the
2 char progressive analysis cycle
Number one is connected to Host computer
Patient ID
8 char Patient identification
Number
Wheel no. 2 char Indicate the progressive number of analysis made
Position 2 char Indicate the sample position inside the wheel
Bayer 2 char
(Note 2) See note 2
Result 4 char ESR result
Checksum 1 char See note 1
(Note 1)

ETX ♥ 03 1 char End transmission


Total length 24 char

DAT15 and BCI Result transmission string:

Note1:
Field name Symbol Hex value Length Description
See note at the end of this
STX ☻ 02 1 char Start transmission
page

„R‟ 52 1 char R states for result message Note2:see previous table


Workstation Is the number identifying the instrument if more than
2 char
Number one is connected to Host computer
Patient ID
15 char Patient identification
Number
Rack no. 2 char Indicate the progressive number of analysis made
Position 2 char Indicate the sample position inside the wheel
Bayer 2 char
(Note 2) See note 2
Result 4 char ESR result
Checksum 1 char See note 1
(Note 1)

ETX ♥ 03 1 char End transmission


Total length 31 char

Checksum value is the result of Exclusive OR (XOR) of all characters of the message, excluded STX, ETX and Checksum. If the Checksum
value calculated by the analyser is 03 (corresponding to ETX), or 02 (corresponding to STX), or 00 (corresponding to NULL), the value will be
automatically replaced with 7F hex value.
Software House must adopt the same procedure when calculating checksum of the strings received from the analyser.

In the Communication menu is possible to choose the appropriate protocol and options:

ESR D195.07.02 Rev. 06 ESR INTERFACING MANUAL Page: 26


ESR Interfacing Manual

Ed. 1 Rev 6 - 2018-May-28

To activate the below option the password 1990 is compulsory.


From Main Screen, the path to enable it is Setup, “Log In – Out, “LOGIN”

A keyboard to type the password is going to be displayed. Type the password:1990 then press the “left arrow” to
confirm or “Clear” to exit without changing anything, in both cases, the instrument is going to display again the
previous image, then press “Back”.

23. RS232 test to check the communication of ROLLER INSTRUMENTS


To activate the below option the password 1990 is compulsory.
From Main Screen, the path to enable it is Setup, “Log In – Out, “LOGIN”

A keyboard to type the password is going to be displayed. Type the password:1990 then press the “left arrow” to
confirm or “Clear” to exit without changing anything, in both cases, the instrument is going to display again the
previous image, then press “Back”.

Pressing Comm menu and TEST it is possible to send a communication test to host computer through RS232
serial port.

If DAT8 is chosen, the test Message If DAT15 or BCI is selected, the test
having 8 ID digits will be sent to Host Message having 15 ID digits is sent to
is: Host is:
<0x2>R01TESTR10A0001010002U<0x3> <0x2>R01TESTR10A 0101010002t<0x3>
<0x2>R01TESTR10B0001020015S<0x3> <0x2>R01TESTR10B 0102010015r<0x3>
<0x2>R01TESTR10C0001030031U<0x3> <0x2>R01TESTR10C 0103010031t<0x3>
<0x2>R01TESTR10D0001040090^<0x3> <0x2>R01TESTR10D 0104010090<0x7f><0x3>
<0x2>R01TESTR10E0001050100V<0x3> <0x2>R01TESTR10E 0105010100w<0x3>
<0x2>R01TESTR10F0001060120T<0x3> <0x2>R01TESTR10F 0106010120u<0x3>
<0x2>R01TESTR10G000107-004N<0x3> <0x2>R01TESTR10G 010701-004o<0x3>
<0x2>R01TESTR10H000108-004N<0x3> <0x2>R01TESTR10H 010801-004o<0x3>
<0x2>R01TESTR10I000109-002H<0x3> <0x2>R01TESTR10I 010901-002i<0x3>
<0x2>R01TESTR10J000110-001@<0x3> <0x2>R01TESTR10J 011001-001a<0x3>

If NO HOST is configured, the instrument will not communicate with Host Computer

ESR D195.07.02 Rev. 06 ESR INTERFACING MANUAL Page: 27


ESR Interfacing Manual

Ed. 1 Rev 6 - 2018-May-28

24. QUERY PROTOCOL for ROLLER INSTRUMENTS


This paragraph describes the serial protocol (Query Protocol) used by ROLLER INSTRUMENTS with an
External Bar Code Reader (EBCR) connected to Serial Port 1 (25 PIN).

Fields to check looking at


the flag list.

25. Protocol explanation (BCI Configuration):


1. The patient bar code ID stuck on each sample tube can be read
by using an External Bar Code Reader connected to Roller 10 <STX>Q01123456789 0000a<ETX>
Serial Port1. The instrument will create and send “Q” message

ESR D195.07.02 Rev. 06 ESR INTERFACING MANUAL Page: 28


ESR Interfacing Manual

Ed. 1 Rev 6 - 2018-May-28

to HOST computer through RS232 serial port (or to LAB PC if it is used like a bridge) if Query Setup option
is 1. (Note 3)
2. HOST computer verifies if the patient identity has been inserted in the working list and then it replies with "T"
message. Roller 10 remains waiting for receiving it on time (within 2 seconds), if ACK option is disabled.
It will wait for all the set time if ACK option is enabled. (Follow the instruction looking on page 22 of this manual.)
3. As soon as the instrument receives “T” message, it is checked. <STX>T01123456789 0001e<ETX>
4. The wheel is going to rotate to one position to allow the operator
to insert the sample tube, if “T” message has the result field <STX>T01123456789 0000d<ETX>
compiled with “0001” (that means the sample requires the
analysis). The wheel will remain stop, if the result field is “0000” (the analysis of that particular sample is not
requested).
th
Before starting the analysis, the explained above, from 1 to 2, procedure will be repeated for the further 10
th
(Roller 10) or the 20 (Roller 20) sample tubes.

5. After measuring (20 seconds about), Roller 10 compile


<STX>R01123456789 0103050012f <ETX>
“R” messages replacing the result field value (0001)
with an ESR value that, read on the paper could be
between values of 0002 and 0120 or a negative one. <STX>R01123456789 010305-004l <ETX>
For reading errors, the instrument will report the error
codes like: --001 for SM error, -002 for NR error and -004 for NF error.
6. Host computer should send an ACK confirmation byte ( ♠ symbol looking at the
Hexadecimal code 0x06
hyper terminal program) to Roller 10 for having accepted “R” message. The
instrument will ignore it, if ACK option is disabled. It will wait for all the set time (TIMEOUT from 2 to 60
seconds) if ACK option is enabled.

Protocol explanation (DAT 8 – DAT 15 Configuration):

In this case the instrument doesn‟t query the Host Computer, it just perform the analisis and send the result to host
computer as explaned at points 3 and 4.

Warnings:
1. If the patient identity (ID) read by the Scanner doesn‟t find its own correspondent in the Host computer
working list, “T” message will be replaced by <NAK> message (§ symbol Hexadecimal code 0x21
looking at the hyper terminal program). If MISS ID option is enabled, the wheel
will rotate to the next position to allow the operator to insert the tube. The sample, then will be analysed and
“R” message sent to host.

2. If no label has been stuck on the tube or the external Scanner cannot read the patient ID, “Q” message won‟t
be created. The wheel is going to rotate to accept the sample tube by pressing “Next” button on touch-screen
display.

3. The sample is going to be processed and “R” message sent to host with an identity code generated by itself.
The new patient ID in this case will be composed by 10 characters:

4. Cycle number (2 characters from 01 to 99), instrument s/n (4 characters), wheel number ( 2 characters)
sample position in the wheel (from 01 to 10- 2 characters).

ESR D195.07.02 Rev. 06 ESR INTERFACING MANUAL Page: 29


ESR Interfacing Manual

Ed. 1 Rev 6 - 2018-May-28

Example:
Instrument s/n Wheel number

0307920106

Cycle number Sample position in the wheel

A complete “R” string for the transmission will be:

[Workstation number] [Instrument s/n] [Wheel number] [ESR] [Checksum]

<STX>R010307920106 0106030012f <ETX>

[Cycle number] [Sample position] [Cycle number (Note 5)]

Note 1: Checksum value is the result of Exclusive OR (XOR) of all characters of the message, excluded STX, ETX and
Checksum. If the Checksum value calculated by the analyser is 03 (corresponding to ETX), or 02 (corresponding
to STX), or 00 (corresponding to NULL), the value will be automatically replaced with 7F hex value.
Software House must adopt the same procedure when calculating checksum of the strings received from
the analyser.

Note 2: <STX> character (☻symbol looking at the hyper terminal program) in the serial transmission is represented by
0x02 hexadecimal bytes and <ETX> ( ♥ symbol looking at the hyper terminal program) by 0x03.

Note 3: If Query Setup option is 0, no Query protocol will be created; the instrument will accept and analyse all samples.

Note 4: Follow the instruction looking at the of the technical manual for TIMEOUT UART activation.

Note 5: This field is related to Bayer parameter on SETUP. If Bayer is 0, the field contains the number of Cycle. If Bayer is
1, the field contains '01' (hex 30 and 31) to keep compatibility with Bayer protocol.

ESR D195.07.02 Rev. 06 ESR INTERFACING MANUAL Page: 30


ESR Interfacing Manual

Ed. 1 Rev 6 - 2018-May-28

26. TEST1, ROLLER20LC and ROLLER INSTRUMENTS Multiple connections


Query protocol is able to manage multiple connections by using the same PC-LAB with multiple serial ports.

Please notice for easiness of explanations, we assume Roller10, Roller10PN, Roller20PN and Roller20MC from this
moment are referred as “Roller Instruments”

In that case every instrument connected to the PC-LAB has to have an identification number different for each and
the PC-LAB the same number of serial ports as the instruments.

Our instruments have an option: TEST1 number in the COMMUNICATION menu for TEST1 models, ROLLER
NUMBER inside Tech Menu for ROLLER20LC models and STR N° inside COMM menu for the “Roller
Instruments” family” to assign a different identification number to each instrument,

“R” message should be different for each like in the following example:

[Workstation number] [Checksum]

<STX> R010307920106 0106030012I <ETX>

[Workstation number] [Checksum]

<STX> R020308100106 0106030012z <ETX>

[Workstation number] [Checksum]

<STX> R030308150106 0106030012~ <ETX>

ESR D195.07.02 Rev. 06 ESR INTERFACING MANUAL Page: 31


ESR Interfacing Manual

Ed. 1 Rev 6 - 2018-May-28

27. INTERFACING LATEX PROTOCOL

LATEX PROTOCOL INTERFACE EXPLICATION VALID ONLY FOR TEST1 AND ROLLER20LC Up to Sw.
version 6.01C (Test 1), 6.01B (Roller20LC)

The three R Latex messages are sent, to the serial port, after having analysed the three referent Latex of the
Control kit and at the end of the washing, by withdrawing water from the fifth and sixth inserted tube, for rinsing the
capillary.
It should be understood R Latex messages are not available by using Calibration Latex kit.

Messages
„R‟ message for Latex
Hex Length
Field name Description
value
STX (Note 2) 02 1 char
„R‟ 52 1 char Means the instrument is sending a Result
Identifies the workstation if more instrument are
Workstation Number 2 char
connected, normally is 01
LATEXSTDL 9 char Is the identification of the latex tube
Can be 1, 2 or 3 and identifies level 1, 2 and 3 of
Field 1 1 char
latex
ESR Value 3 char This is the expected Latex ESR value
Space. 20 2 char Two spaces
Field 2 2 char Fixed to 01
Field 3 2 char The same as Field 1
Field 4 2 char The same as Field 2
ESR Value 4 char This is the detected Latex ESR value
Checksum (Note 1) 1 char
ETX 03 1 char

Total length 31 char

Note 1: Checksum value is the result of Exclusive OR (XOR) of all characters of the message, excluded STX, ETX and
Checksum. If the Checksum value calculated by the analyser is 03 (corresponding to ETX), or 02 (corresponding
to STX), or 00 (corresponding to NULL), the value will be automatically replaced with 7F hex value.
Software House must adopt the same procedure when calculating checksum of the strings received from
the analyser.

Note 2: <STX> character (☻symbol looking at the hyper terminal program) in the serial transmission is represented by 0x02 hexadecimal
bytes and <ETX> ( ♥ symbol looking at the hyper terminal program) by 0x03.

here are some examples:


<0x2>R01LATEXSTDL1005 0100010005^<0x3>
<0x2>R01LATEXSTDL2028 0101010029><0x3>
<0x2>R01LATEXSTDL3071 0102010072><0x3>

ESR D195.07.02 Rev. 06 ESR INTERFACING MANUAL Page: 32


ESR Interfacing Manual

Ed. 1 Rev 6 - 2018-May-28

LATEX PROTOCOL INTERFACE EXPLICATION From Sw. version 6.01D on ward up to Sw 6.51x and from
Sw 8.00x on ward (Test 1), 6.01C up to Sw 6.51x and from Sw 8.00x on ward (Roller20LC) and from 1.00P on
ward ( Roller 10-10PN / 20PN / R20P2) and Roller 20 MC (from Sw. version 4.00A)

When the instrument runs latex controls, it is possible to send the results to host computer, in this case the instrument will
send a specific string here explained:

Please notice for easiness of explanations, we assume Roller10, Roller10PN, Roller20PN, Roller20PN2 and
Roller20MC from this moment are referred as “Roller Instruments”

„R‟ message for Latex


Hex Length
Field name Description
value
STX (Note 2) 02 1 char
„R‟ 52 1 char Means the instrument is sending a Result
Identifies the workstation if more instrument are
Workstation Number 2 char
connected, normally is 01
Is the identification of the latex and the Lot
LATEX0 XYZ 9 char
to which they belong
Can be 1, 2 or 3 and identifies level 1, 2 and 3 of
Field 1 1 char
latex
ESR Value 3 char This is the expected Latex ESR value
Space. 20 2 char Two spaces
Field 2 2 char Fixed to 01
Field 3 2 char The same as Field 1
Field 4 2 char The same as Field 2
ESR Value 4 char This is the detected Latex ESR value
Checksum (Note 1) 1 char
ETX 03 1 char

Total length 31 char

Note 1: Checksum value is the result of Exclusive OR (XOR) of all characters of the message, excluded STX, ETX and
Checksum. If the Checksum value calculated by the analyser is 03 (corresponding to ETX), or 02 (corresponding
to STX), or 00 (corresponding to NULL), the value will be automatically replaced with 7F hex value.
Software House must adopt the same procedure when calculating checksum of the strings received from
the analyser.

here are some examples:

<0x2>R01LATEX08451005 0101010002<0x19><0x3>
<0x2>R01LATEX08452036 0102010034<0x1c><0x3>
<0x2>R01LATEX08453083 0103010071<0x13><0x3>

ESR D195.07.02 Rev. 06 ESR INTERFACING MANUAL Page: 33

You might also like