CC2777-11 Serial Export Protocol Agilia Range Eng

Serial Export Protocol
FOR AGILIA RANGE

Revision list
Information in this document only refer to devices belonging to the Agilia Family:
Device Software Version
Injectomat up to 2.5g
Injectomat MC up to 4.3h
Injectomat TIVA up to 4.3h
Volumat up to 1.2e
Volumat MC up to 2.3f
Link+ (type 0x12) up to 3.0 (D14)
Link+ (type 0x02) up to 2.11
Date Rev. Modifications

25/10/06 0 First issue
24/09/07 1 Change First page
Add numbering system
Add a table of contents
§2.1.3 and §2.1.4: add CRC explanations
§3.2.2 Device status frame updated with Volumat Agilia device
Add annex with full Device status frame for injectomat and Volumat device
03/11/08 2 §4.3 Update of CRC16
§5 Remove command 40h DataId
§5 Give an example frame for all commands
§5.4 Rework of the the MinDuration/MaxDuration description
§5.6.2 Rework of the drug management
§5.6.1 Add the patient management
§5.6: Update STRING/VSTRING
§7 Rework of the Device status frame subId description
20/03/09 3 Modified §5.2 Commands and messages description:
Added Advanced Infusion Data §5.6
Modified §5.3 Protocol:
Added Link+ Device status/Opening/Closing frame
Added §5.6 Additional Infusion Informations
Modified §7 Annex: Volumat and Injectomat Device status SubId
Added UserVolumePri and UserVolumeSec
15/09/09 4 Modified §7 Annex, §4.3 CRC16, §5.6.2 Data Id 4D & 4E and §5.7.1 Patient
Management
2 CC2777-11_serial_export_protocol_agilia_range_eng.doc
Date Rev. Modifications
21 feb. 2012 5 Added new Link+ specificities, version id=0x12, with Alarm Management
Restricted command set
Removed Link+ id=0x01/0x02 specificities (product discontinued)
15 june 2012 6 PR corrections:
*1092 : SubId-01 description
*1101 : Frame F0h description
*1102 : Frame DFh description
*1115 : Add Advance Data 07h (Flowrate in ml/h)
*1119 : SubId-02 Flowrate Unit description
*1120 : Volume Units in SubId-02
*1327 : Description of Frame format
CR : change Frame id-00 description
CR : Recommended Communication Parameters description
CR : add Recommendations when using Link+
06 may 2013 7 CR3482 :
- New command : get IP address
- Suppression of CRC16 deactivation
CR4168 :
- Communication over TCP
Jan. 05th 2015 8 CR8555 :

- Chapter 4.4: Add definition of Device Status Information Frame (aka
“Supervision Frame”) in stand-by mode
- Chapter 4.6.1: Add rules for Infusion Data usage in stand-by mode
- Chapter 4.7: Add precision for IP Address data
March 12th, 9 - Patient SubId01: upgrade the description
2019
- MinDuration and MaxDuration: improve parameters descriptions
- First Block of Data: Volumat Agilia: Alarms description fixed
August 29th 10 - Infusion SubId 0x02: add precision on “Pressure” Field for Volumetric Pump
2019
- Infusion SubId 0x02: add precision on “Dilution” related Fields for Volumetric Pump
- Frame Id 0xF0: update Link+ Close session parameters
- Add a new chapter on volumes signification.
- Add a new chapter on decimal place rules for display
- Add a new chapter on rounding rules for display
November 2019 11 - Fix chapter 6.4 on decimal place rules for display
- Fix DataId 0x07: FlowRate
- Fix Chapter 4.5: Device information
CC2777-11_serial_export_protocol_agilia_range_eng.doc 3
Table of contents
1. INTRODUCTION .................................................................................................................................................. 6
2. PHYSICAL LINK .................................................................................................................................................. 6
2.1 SERIAL ......................................................................................................................................................... 6
2.2 TCP ............................................................................................................................................................ 6
3. DATA LINK .......................................................................................................................................................... 7
3.1 FRAME FORMAT ............................................................................................................................................ 7
3.2 ENCODING .................................................................................................................................................... 8
3.2.1 UNITS ENCODING .................................................................................................................................................... 8
3.2.2 DATES ................................................................................................................................................................... 8
3.3 CRC8 .......................................................................................................................................................... 9
3.4 CRC16 ........................................................................................................................................................ 10
3.5 EXAMPLE OF COMPLETE FRAME .................................................................................................................... 12
3.6 FRAME EXCHANGE ....................................................................................................................................... 13
3.6.1 DEFINITION ............................................................................................................................................................. 13
3.6.2 COMMUNICATION PARAMETERS ............................................................................................................................... 15
3.6.2.1 PacketMinRate_ms ............................................................................................................................................... 15
3.6.2.2 PacketRepeatTimeout_ms ..................................................................................................................................... 16
3.6.2.3 DisconnectTimeout_ms ......................................................................................................................................... 17
3.6.3 RECOMMENDED COMMUNICATION PARAMETERS ....................................................................................................... 18
3.6.4 RECOMMENDATIONS WHEN USING PUMPS PLUGGED ON A LINK+................................................................................. 18
4. APPLICATION LAYER – MESSAGE EXCHANGED .......................................................................................... 19
4.1 SESSION LAYER ........................................................................................................................................... 19
4.1.1 START OF COMMUNICATION ..................................................................................................................................... 19
4.1.2 END OF COMMUNICATION ......................................................................................................................................... 19
4.1.3 ERRORS MANAGEMENT............................................................................................................................................ 19
4.2 COMMANDS AND MESSAGES DESCRIPTION ..................................................................................................... 20
4.3 PROTOCOL ................................................................................................................................................... 21
4.4 DEVICE STATUS ............................................................................................................................................ 24
4.4.1 DEFINITION ............................................................................................................................................................. 24
4.4.1.1 First Block of Data : Injectomat Agilia ................................................................................................................. 28
4.4.1.2 First Block of Data : Volumat Agilia .................................................................................................................... 30
4.4.2 VOLUMAT AND INJECTOMAT DEVICE STATUS SUBID ................................................................................................... 32
4.4.2.1 Patient SubId ......................................................................................................................................................... 32
4.4.2.2 Infusion SubId ....................................................................................................................................................... 33
4.4.2.3 TCI SubId .............................................................................................................................................................. 34
4.4.2.4 Device SubId ......................................................................................................................................................... 34
4.5 DEVICE INFORMATION ................................................................................................................................... 35
4.6 ADDITIONAL INFUSION INFORMATION ............................................................................................................. 36
4.6.1 ADVANCED DATA INFUSION READING ........................................................................................................................ 36
4.6.2 LIST OF DATAID ...................................................................................................................................................... 37
4.6.2.1 Flowrate ................................................................................................................................................................ 37
4.6.2.2 Infused Volume ..................................................................................................................................................... 37
4.6.2.3 Manual Bolus ........................................................................................................................................................ 37
4.6.2.4 Simple Bolus ......................................................................................................................................................... 37
4.6.2.5 Loading Dose ........................................................................................................................................................ 37
4.6.2.6 Programmed Bolus ................................................................................................................................................ 38
4.6.2.7 Availability of DataId ........................................................................................................................................... 38
4.7 IP ADDRESS ................................................................................................................................................. 39
4.8 ERROR CODES ............................................................................................................................................. 40
4.9 TYPES OF VARIABLES ................................................................................................................................... 42
5. VOLUMES DISPLAYED ON SCREEN VS API ................................................................................................... 43
6. DECIMAL PLACE RULES FOR VALUES DISPLAYED ON SCREEN .............................................................. 44
6.1 INJECTOMAT - FLOW RATE / DOSE RATE ....................................................................................................... 44
6.1.1 MACRO MODE ........................................................................................................................................................ 44
6.1.1.1 Drug is programmed with a Flow Rate (mL/h) ..................................................................................................... 44
6.1.1.2 Drug is programmed with a Dose Rate (NOT mL/h) ............................................................................................ 44
6.1.2 MICRO MODE ......................................................................................................................................................... 44
6.2 INJECTOMAT - CONCENTRATIONS .................................................................................................................. 45
6.3 VOLUMAT - FLOW RATE / DOSE RATE ........................................................................................................... 46
6.3.1 MACRO MODE ........................................................................................................................................................ 46
6.3.2 MICRO MODE ......................................................................................................................................................... 46
6.4 VOLUME - DOSE ........................................................................................................................................... 47
7. ROUDING RULES FOR VALUES DISPLAYED ON SCREEN ........................................................................... 48
7.1 FLOWRATE / DOSERATE / CONCENTRATION................................................................................................... 48
7.2 VOLUMES / DOSE.......................................................................................................................................... 48
8. LOCAL CONTACTS FOR SERVICING ............................................................................................................... 49
1. INTRODUCTION
This guide is intended for the non-Fresenius Kabi personnel who want to communicate with the Agilia range devices. It
describes the communication system used between a device and a host device (computer, …) and gives a list of all the
available commands and information.
In case of clustered architecture, the host can communicate with each of the devices via the Link+ accessory.
The Link+ is fully transparent in the communication.
The reliability of the communication system is based on the definition of 4 distinct communication layers:
▪ A Physical Link Layer to describe the type of signals and their parameters.
▪ A Data Link Layer to specify the character frame construction mechanisms.
▪ A Session Layer through which communication is established.
▪ An Application Layer which describes the syntax of the message exchanged between the two systems (host/device).
This layer is the only visible one and it must be treated separately from the other ones. The application layer informs
the errors detected by the other layers.
The following functions are available:
▪ Setting (Silence alarm…)
▪ Information request (Infusion status…)
2. PHYSICAL LINK
The communication protocol can be used with the appropriate cable accessories only.
Please refer to the IFU of the devices for the required accessory references.
2.1 Serial
The serial communication uses the standard following configuration (cannot be modified):
• Baud rate : 115200
• Data bits : 8
• Parity bit : no
• Stop bit: yes (1 stop bit)
• RTS (Request To Send) : enabled
• DTR (Data Terminal Ready) : enabled
2.2 TCP
The TCP communication uses the standard following configuration:
• IP of the Link : configured in WebInterface ( default 192.168.0.1 )
• Protocol : TCP
• Port : configured in WebInterface ( default 52000 )
3. DATA LINK
3.1 Frame format

Whatever the transfer direction (Host to Device or Device to Host), the frames are always built as follow:
START TYPE NO ACK SZ CRC8 ID DATA CRC16
Description of the different fields of such a frame:

Type Name Description
BYTE START Start of frame : 0x1B (ESC)
BYTE TYPE see Definition below
BYTE NO Frame number (0x01..0xFF)
BYTE ACK Number of the last acknowledged frame (0x01...0xFF)
BYTE SZ Size of the ID and DATA fields
CRC (8 bits) computed from the TYPE, NO, ACK and SZ
BYTE CRC8
fields
BYTE ID Frame Id (if SZ is different from 0)
Data: from 0 to 254 characters (if SZ is different from
BYTES DATA
0)
CRC (16 bits) computed from the ID and DATA fields (if
WORD CRC16
SZ is different from 0)
The data are systematically written using the big endian format.
Definition of field Type :

For communication with:
Pump (direct Link+ Pump plugged on Link+
Serial
Connection)
Spontaneous Frames 0x60 (‘`’) None 0x61 (‘a’) : Pump 1 (lowest slot on Link+)
…
0x68 (‘h’) : Pump 8 (upper slot on Link8+)
Standard Frames 0x40 (‘@’) 0x40 (‘@’) 0x41 (‘A’) : Pump 1 (lowest slot on Link+)
…
0x48 (‘H’) : Pump 8 (upper slot on Link8+)
3.2 Encoding
3.2.1 Units Encoding

Units are encoded within 2 bytes (16 bits) as follow:
MSB (bit 12) LSB (bit 0)
Surface Prefix Unit Patient’s Time Dilution Plasma
weight
0 - 000 p 000 g 0 - 00 - 00 - 0 -
1 /m² 001 n 001 l 1 /kg 01 /min 01 /ml 1 /ml plasma
010 µ 010 U 10 /h 10 /l
011 m 011 mol 11 /24h 11 /X ml
100 - 100 cal
101 k
110 M
111 G
Examples :
• 0x0000 = pg
• 0 100 010 1 10 00 0 = U/kg/h
When a dilution is used (/X ml), a WORD that contains the volume of dilution is added after the unit.
3.2.2 Dates
Dates are encoded within 4 bytes (32 bits). The value corresponds to the number of seconds passed since January the
1st of September 1970.
3.3 CRC8
The CRC8 is calculated for the header of every packet. The bytes computed are TYPE, NO, ACK and SZ fields, so the 4
bytes next to the start byte (ESC).
START TYPE NO ACK SZ CRC8
The algorithm use an array of 256 constants values and is described below :
CRC = 0
FOR EACH byte_to_compute
CRC = ConstArray[ byte_to_compute XOR CRC ]
Implementation in C :
static const BYTE k_abyCrcArray[256] = {
0x00, 0x5e, 0xbc, 0xe2, 0x61, 0x3f, 0xdd, 0x83,
0xc2, 0x9c, 0x7e, 0x20, 0xa3, 0xfd, 0x1f, 0x41,
0x9d, 0xc3, 0x21, 0x7f, 0xfc, 0xa2, 0x40, 0x1e,
0x5f, 0x01, 0xe3, 0xbd, 0x3e, 0x60, 0x82, 0xdc,
0x23, 0x7d, 0x9f, 0xc1, 0x42, 0x1c, 0xfe, 0xa0,
0xe1, 0xbf, 0x5d, 0x03, 0x80, 0xde, 0x3c, 0x62,
0xbe, 0xe0, 0x02, 0x5c, 0xdf, 0x81, 0x63, 0x3d,
0x7c, 0x22, 0xc0, 0x9e, 0x1d, 0x43, 0xa1, 0xff,
0x46, 0x18, 0xfa, 0xa4, 0x27, 0x79, 0x9b, 0xc5,
0x84, 0xda, 0x38, 0x66, 0xe5, 0xbb, 0x59, 0x07,
0xdb, 0x85, 0x67, 0x39, 0xba, 0xe4, 0x06, 0x58,
0x19, 0x47, 0xa5, 0xfb, 0x78, 0x26, 0xc4, 0x9a,
0x65, 0x3b, 0xd9, 0x87, 0x04, 0x5a, 0xb8, 0xe6,
0xa7, 0xf9, 0x1b, 0x45, 0xc6, 0x98, 0x7a, 0x24,
0xf8, 0xa6, 0x44, 0x1a, 0x99, 0xc7, 0x25, 0x7b,
0x3a, 0x64, 0x86, 0xd8, 0x5b, 0x05, 0xe7, 0xb9,
0x8c, 0xd2, 0x30, 0x6e, 0xed, 0xb3, 0x51, 0x0f,
0x4e, 0x10, 0xf2, 0xac, 0x2f, 0x71, 0x93, 0xcd,
0x11, 0x4f, 0xad, 0xf3, 0x70, 0x2e, 0xcc, 0x92,
0xd3, 0x8d, 0x6f, 0x31, 0xb2, 0xec, 0x0e, 0x50,
0xaf, 0xf1, 0x13, 0x4d, 0xce, 0x90, 0x72, 0x2c,
0x6d, 0x33, 0xd1, 0x8f, 0x0c, 0x52, 0xb0, 0xee,
0x32, 0x6c, 0x8e, 0xd0, 0x53, 0x0d, 0xef, 0xb1,
0xf0, 0xae, 0x4c, 0x12, 0x91, 0xcf, 0x2d, 0x73,
0xca, 0x94, 0x76, 0x28, 0xab, 0xf5, 0x17, 0x49,
0x08, 0x56, 0xb4, 0xea, 0x69, 0x37, 0xd5, 0x8b,
0x57, 0x09, 0xeb, 0xb5, 0x36, 0x68, 0x8a, 0xd4,
0x95, 0xcb, 0x29, 0x77, 0xf4, 0xaa, 0x48, 0x16,
0xe9, 0xb7, 0x55, 0x0b, 0x88, 0xd6, 0x34, 0x6a,
0x2b, 0x75, 0x97, 0xc9, 0x4a, 0x14, 0xf6, 0xa8,
0x74, 0x2a, 0xc8, 0x96, 0x15, 0x4b, 0xa9, 0xf7,
0xb6, 0xe8, 0x0a, 0x54, 0xd7, 0x89, 0x6b, 0x35,
};
BYTE Comm_CalcCrc8( const BYTE * i_pbyBuffer, int i_iSize )

{
BYTE byCRC = 0;
int i;
for (i=0 ; i<i_iSize ; i++)
byCRC = k_abyCrcArray[ (i_pbyBuffer[i] ^ byCRC) ];
return byCRC;
}
3.4 CRC16
The CRC16 is calculated for the data part of a packet if there is one. The bytes computed are ID and all data bytes, so it
is the number of bytes indicated by the SZ field.
START TYPE NO ACK SZ CRC8 ID DATA CRC16

SZ bytes…
The public domain CRC algorithm used come from Ross Williams (ross@guest.adelaide.edu.au) and is dated 3 June
1993. This is the implementation (.c) file for the reference implementation of the Rocksoft^tm Model CRC Algorithm. For
more information on the Rocksoft^tm Model CRC Algorithm, see the document titled “A Painless Guide to CRC Error
Detection Algorithms” by Ross Williams. This document is likely to be in “ftp.adelaide.edu.au/pub/rocksoft”.
The most recent home (2007) for Ross Williams documentation is : http://www.ross.net/crc/
▪ The algorithm used is described below :

CRC = 0
FOR EACH byte_to_compute
CRC = ConstArray[(byte_to_compute XOR CRC) AND 0xff] XOR (CRC >>8)
▪ Implementation in C:
#define CRC_UPDATEBYTE16( i_byVal, i_wCrc ) \
(kg_crc_awTable16[((i_wCrc)^(i_byVal))&0xff]^((i_wCrc)>>8))
typedef unsigned long DWORD;
WORD const kg_crc_awTable16 [256] =
{
0x0000, 0xC0C1, 0xC181, 0x0140, 0xC301, 0x03C0, 0x0280, 0xC241,
0xC601, 0x06C0, 0x0780, 0xC741, 0x0500, 0xC5C1, 0xC481, 0x0440,
0xCC01, 0x0CC0, 0x0D80, 0xCD41, 0x0F00, 0xCFC1, 0xCE81, 0x0E40,
0x0A00, 0xCAC1, 0xCB81, 0x0B40, 0xC901, 0x09C0, 0x0880, 0xC841,
0xD801, 0x18C0, 0x1980, 0xD941, 0x1B00, 0xDBC1, 0xDA81, 0x1A40,
0x1E00, 0xDEC1, 0xDF81, 0x1F40, 0xDD01, 0x1DC0, 0x1C80, 0xDC41,
0x1400, 0xD4C1, 0xD581, 0x1540, 0xD701, 0x17C0, 0x1680, 0xD641,
0xD201, 0x12C0, 0x1380, 0xD341, 0x1100, 0xD1C1, 0xD081, 0x1040,
0xF001, 0x30C0, 0x3180, 0xF141, 0x3300, 0xF3C1, 0xF281, 0x3240,
0x3600, 0xF6C1, 0xF781, 0x3740, 0xF501, 0x35C0, 0x3480, 0xF441,
0x3C00, 0xFCC1, 0xFD81, 0x3D40, 0xFF01, 0x3FC0, 0x3E80, 0xFE41,
0xFA01, 0x3AC0, 0x3B80, 0xFB41, 0x3900, 0xF9C1, 0xF881, 0x3840,
0x2800, 0xE8C1, 0xE981, 0x2940, 0xEB01, 0x2BC0, 0x2A80, 0xEA41,
0xEE01, 0x2EC0, 0x2F80, 0xEF41, 0x2D00, 0xEDC1, 0xEC81, 0x2C40,
0xE401, 0x24C0, 0x2580, 0xE541, 0x2700, 0xE7C1, 0xE681, 0x2640,
0x2200, 0xE2C1, 0xE381, 0x2340, 0xE101, 0x21C0, 0x2080, 0xE041,
0xA001, 0x60C0, 0x6180, 0xA141, 0x6300, 0xA3C1, 0xA281, 0x6240,
0x6600, 0xA6C1, 0xA781, 0x6740, 0xA501, 0x65C0, 0x6480, 0xA441,
0x6C00, 0xACC1, 0xAD81, 0x6D40, 0xAF01, 0x6FC0, 0x6E80, 0xAE41,
0xAA01, 0x6AC0, 0x6B80, 0xAB41, 0x6900, 0xA9C1, 0xA881, 0x6840,
0x7800, 0xB8C1, 0xB981, 0x7940, 0xBB01, 0x7BC0, 0x7A80, 0xBA41,
0xBE01, 0x7EC0, 0x7F80, 0xBF41, 0x7D00, 0xBDC1, 0xBC81, 0x7C40,
0xB401, 0x74C0, 0x7580, 0xB541, 0x7700, 0xB7C1, 0xB681, 0x7640,
0x7200, 0xB2C1, 0xB381, 0x7340, 0xB101, 0x71C0, 0x7080, 0xB041,
0x5000, 0x90C1, 0x9181, 0x5140, 0x9301, 0x53C0, 0x5280, 0x9241,
0x9601, 0x56C0, 0x5780, 0x9741, 0x5500, 0x95C1, 0x9481, 0x5440,
0x9C01, 0x5CC0, 0x5D80, 0x9D41, 0x5F00, 0x9FC1, 0x9E81, 0x5E40,
0x5A00, 0x9AC1, 0x9B81, 0x5B40, 0x9901, 0x59C0, 0x5880, 0x9841,
0x8801, 0x48C0, 0x4980, 0x8941, 0x4B00, 0x8BC1, 0x8A81, 0x4A40,
0x4E00, 0x8EC1, 0x8F81, 0x4F40, 0x8D01, 0x4DC0, 0x4C80, 0x8C41,
0x4400, 0x84C1, 0x8581, 0x4540, 0x8701, 0x47C0, 0x4680, 0x8641,
0x8201, 0x42C0, 0x4380, 0x8341, 0x4100, 0x81C1, 0x8081, 0x4040
} ;
/*---------------------------------------------------------------------*/
/* Crc 16 Calculation */
/* - <i_pbyBuf> buffer address */
/* - <i_dwSize> buffer size (bytes) */
/* Out : */
/* - Crc16 */
/* Calculation Crc : x16 + x15 + x2 + 1 (0x8005) */
/*---------------------------------------------------------------------*/
aWORD crc_C_Calc16( BYTE C* i_pbyBuf, DWORD i_dwSize )
{
return crc_C_Update16( i_pbyBuf, i_dwSize, 0 ) ;
}
/*--------------------------------------------------------------------*/
/*--------------------------------------------------------------------*/
aWORD crc_C_Update16( BYTE C* i_pbyBuf, DWORD i_dwSize, aWORD i_wCrc )
{
aBYTE byVal ;
while ( i_dwSize != 0 )
{
byVal = *i_pbyBuf++ ;
i_wCrc = CRC_UPDATEBYTE16( byVal, i_wCrc ) ;
--i_dwSize ;
}
return i_wCrc ;
}
3.5 Example of complete frame
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
ESC @ 00 00 0B C0 70 01 08 08 00 13 88 4E 20 FF FF 8C 68
Frame description (see frame 0x70 § 0 for the data description):

1 ESC Start of the frame
2 @ Frame type: “classical” frame (not spontaneous)
3 00 Frame number = 0
4 00 Number of the last acknowledged frame = 0
5 0B Size of the ID and DATA fields = 10 bytes
6 C0 CRC (8 bits) computed from the TYPE, NO, ACK and SZ fields
7 70 Frame Id = Opening/closing of a communication session (see § 0)
Frame Data: Mode = opening of a communication session in Full Duplex
8 01
mode
9 08 Frame Data: Size of the host “window” of communication = 8 messages
10 08 Frame Data: Size of the device “window” of communication = 8 messages
11 00 Frame Data: Disconnect Behaviour = do nothing when disconnected

Frame Data: Value of the PacketRepeatTimeout_ms parameter (see §
12-13 13 88
3.6.2.2)
14-15 4E 20 Frame Data: Value of the PacketMinRate_ms parameter (see § 3.6.2.1)
Frame Data: Value of the DisconnectTimeout_ms parameter (see §
16-17 FF FF
3.6.2.3)
18-19 8C 68 CRC (16 bits) computed from the ID and DATA fields = 35944
3.6 Frame Exchange
3.6.1 Definition
Before any message exchange, it is necessary to open communication session with the device. Similarly, at the end of
the dialogue, the communication session must be properly closed.
However, some frames can be spontaneously sent by the device to the host out of a communication session.
The Agilia devices periodically sends a Device status frame to the host when the communication session is closed.
The exchange of frames follows an acknowledgement protocol based on a “window” mechanism that allows to transmit
several frames before the first acknowledge is received. The number of frames of a “window” to transmit must be
configured at the opening of the communication session.
With this system, the frames can be acknowledged one by one (one acknowledgement frame sent for one frame
received) or all together (one acknowledgement frame sent for all the frames received).
If one frame of a “window” has not been acknowledged, all the frames that follows this frame in the “window” are repeated
automatically.
According to the type of frame sent by the host, the device can send a frame as a response but also either a list of frames
or no frame at all.
The device and the host have their own frame numbering.
Example: window 4/4
Host sends frames 14, 15, 16, 17; Device answer with frames 7, 8, 9, 10.
Example of the “window” mechanism with a “window” which contains 4 frames:
HOST SERIAL LINK DEVICE
Frame1
Frame RX PROCESSING TX
1
Frame2
Frame3
Frame4 Reply1
Frame1
Frame Frame1  Reply1 Ack1
1 Ack2
Frame2 Frame2  No Reply
Frame3 Frame3  No Reply Ack3
Frame4 Frame4  Reply

Reply4
Reply1
Ack4
Ack1
Ack2
(the frames are acknowledged one by one)
Ack3
Reply4
Ack4
If the frame is empty (size = 0), the frame number is ignored and only the acknowledge number is taken into account.
If a non empty frame (size > 0) with a frame number null is received, the list of received messages is flushed.
Same example in the case of a packet loss:
HOST SERIAL LINK DEVICE
Frame1
Frame RX TREATMENT TX
1
Frame2
Frame3 Frame2
lost
Frame4
Reply1
Frame1
Frame Frame1  Reply1
Ack1
1
Frame3
ignored
Frame4
ignored
Reply1
Ack1
Automatic repetition of frames 2, 3 and 4
Frame2
Frame3
Ack2
Frame4 Frame2 Frame2  No Reply
Frame3 Frame3  No Reply Ack3
Ack2 Frame4 Frame4  Reply4

Reply4
Ack4
Ack3
Reply4
Ack4
3.6.2 Communication Parameters
In order to maintain the connection between the host and the device, some parameters can be configured at the opening
of the session. These parameters are used to configure disconnection of the communication and the repetition of the
frames transmission.
Note : Be very careful when configuring those parameters if you don’t want to have any
trouble in the communication between the host and the device.
In the following paragraphs are described those parameters, and their recommended values in different configurations.
3.6.2.1 PacketMinRate_ms
If there is no communication between the host and the device during the time defined by PacketMinRate_ms, the host
and the device send an empty frame to each other to maintain the connection.
HOST DEVICE
ESC @ 03 …
ESC @ 03 …
Treatment of frame #03

PacketMinRate_ms
ESC @ 04 03 …
ESC @ 04 03 …
.....
Transmission of a empty frame, without frame number, to maintain the
PacketMinRate_ms
connection. The last acknowledged frame number is inserted.
ESC @ 00 03 …
The same for DEVICE
ESC @ 00 …
Time Time
3.6.2.2 PacketRepeatTimeout_ms
Each frame that is emitted must be acknowledged. If the device which has emitted a frame has not received an
acknowledgement before the end of the duration defined by PacketRepeatTimeout_ms, it emits the frame an other time.
Example of a communication without re-emission of the frame:
HOST DEVICE
ESC @ 01 00 …
ESC @ 01 00 …
PacketRepeatTimeout_
ESC @ 01 01 …
ms
ESC @ 01 01 …
Reception of the acknowledgement of the frame
#01
t < PacketRepeatTimeout_ms  no re-emission of the frame
Time
Example of a communication with re-emission of the frame:
HOST DEVICE
ESC @ 02 01 …
PacketRepeatTimeout_ms
ESC @ 02 01 …
t
ESC @ 02 01 …
ESC @ 02 01 …
Reception of the acknowledgement of the frame
#01
ESC @ 02 01 …
Re-emission of the frame
Time
t > PacketRepeatTimeout_ms  re-emission of the frame
3.6.2.3 DisconnectTimeout_ms
If no data are received by the host from the device during the time defined by DisconnectTimeout_ms, the session is
automatically closed.
HOST DEVICE
ESC @ 01 00 …
ESC @ 01 00 …
ESC @ 02 01 …
DisconnectTimeout_ms
ESC @ 02 01 …
Bad CRC  the frame is not taken into
account (frame not acknowledged)
ESC @ 01 00 …
Re-emission of the frame #01
ESC @ 01 00 …
DISCONNECTION
ESC @ 02 01 …
(CLOSING OF THE SESSION)
Re-emission of the frame #02
ESC @ 02 01 …
Time
Example of bad frame reception: incorrect CRC
3.6.3 Recommended Communication Parameters
The following values are recommended to have a robust communication:
Parameter Value
Host “window” 8
Device “window” 8
PacketMinRate_ms 20000ms
PacketRepeatTimeout_ms 3000ms
DisconnectTimeout_ms 60000ms
The PacketRepeatTimeout_ms ensures that a full “window” (almost 8*270 bytes) can be emitted even if the transmission
time is long.
The DisconnectTimeout_ms ensures that a packet can be re-emitted several times.
The PacketMinRate_ms parameter is above the PacketRepeatTimeout_ms and below the DisconnectTimeout_ms.
3.6.4 Recommendations when using Pumps plugged on a Link+

The developed application/driver communicating with Agilia devices shall not request more than 10 frames per second,
spread over the connected pumps.
For example:
- 10 requests on pump 1
- Or 6 requests on pump 1 and 4 requests on pump 2
4. APPLICATION LAYER – MESSAGE EXCHANGED
The messages exchanged between the host and the device must respect the mechanism previously described to ensure
a perfect comprehension of each other.
4.1 Session Layer
4.1.1 Start of communication

All communication between the host and the device must begin with the opening of a communication session between
them (frame ID: 0x70).
Any message sent before the session is opened generates an error message.
Only the device can send spontaneous messages out of a communication session. These messages are not sent during
the communication session. The emitted frames out of a communication session are not numbered (number of frame = 0)
4.1.2 End of communication

Similarly to the opening of a communication session, when the host wishes to end communication, it must close the
communication session (frame ID: 0x70).
The session is automatically closed in the following cases:
• Physical disconnection of the device
• No reply of the device during DisconnectTimeout_ms
4.1.3 Errors management

All errors are sent by the device to the host through a NACK frame (frame ID: 0xFF) whose one of the parameters
indicates the type of error. This frame and all error codes are described later in the present document.
4.2 Commands and messages description
The commands are divided in 2 groups: those which are emitted by the device (DeviceHost) and those which are
emitted by the host (HostDevice).
These commands cannot be used in all the functional modes of the device. Here are the different functional modes in
which the device can work:
Code (hexa) Functional Mode

01 Idle mode : device in idle mode
02 the device is switched on
Here is the list of commands and messages:

ID (HEXA) Description
PROTOCOL
70h Request for opening/closing a communication session (HOST  DEVICE)
F0h Opening/closing a communication session (DEVICE  HOST)
71h Request for NOP (HOST  DEVICE)
F1h Reply for NOP (DEVICE  HOST)
FFh NACK (DEVICE  HOST)
DEVICE STATUS
00h Request for Device status information (HOST  DEVICE)
80h Device status information (DEVICE  HOST)
5Fh Request for Advanced Infusion Data (HOST  DEVICE)
DFh Advanced Infusion Data (DEVICE  HOST)
40h Request for device information (HOST  DEVICE)
C0h Device information (DEVICE  HOST)
64h Request for IP address (HOST  DEVICE)
E4h IP address (DEVICE  HOST)
4.3 Protocol
As described before, the session opening allows to specify the size of the communication “windows” and the value of the
parameters used to configure the connection (PacketMinRate_ms, PacketRepeatTimeout_ms,
DisconnectTimeout_ms…).
The host send a frame to ask the device to open a session (frame ID: 0x70). Then, the device reply with a frame (frame
ID: 0xF0) with the parameters of the connection established. These parameters are the real parameters. They can differ
from those sent by the host.
If the session cannot be opened, the device replies with a NACK frame (frame ID: 0xFF).
A frame sent to open a session has its number set to 0. All the frames that have not been sent yet are lost. In a same
way, all the frames that are waiting for a treatment by the device (even those received after the request for opening the
session) are lost.
A frame sent to close a session can have its number set to 0. In this case, all the frame that are waiting for a treatment
are lost. On the other hand, if this number is different from 0, the frame will be taken into account only when all the
previous frames will be treated. In the both cases, the reply is sent with a frame number set to 0 and all the frames that
have not already been sent are lost.
FRAME ID: 0x70 – Request for opening/closing a communication session (HOST  DEVICE)
Injectomat / Volumat / Link+ (all versions):

TYPE Name Description
BYTE Mode 00 : Request to Close the session
01 : request to Open the session in Full duplex mode
BYTE HostWindow Size of the “window” of messages requested for the
host (1..126)
BYTE DeviceWindow Size of the “window” of messages requested for the
device (1..126)
BYTE DisconnectBehaviour Not used
WORD PacketRepeatTimeout_ Value of the PacketRepeatTimeout_ms parameter in ms
ms (1..65535)
WORD PacketMinRate_ms Value of the PacketMinRate_ms parameter in ms (0 if
not set, 1..65535)
WORD DisconnectTimeout_ms Value of the DisconnectTimeout_ms parameter in ms
(1..65535, 0 forbidden)
FRAME ID: 0xF0 – Ack for Opening a communication session (DEVICE  HOST)
Injectomat / Volumat / Link+ (all versions):

BYTE Mode 01 : Session opened in Full duplex mode
02 : Session opened in Half duplex mode
BYTE HostWindow Size of the “window” of messages taken into account
for the Host (1.. 126)
BYTE DeviceWindow Size of the “window” of messages taken into account
for the device (1.. 126)
FRAME ID: 0xF0 – Ack for Closing a communication session (DEVICE  HOST)
Injectomat / Volumat / Link+ (version id=0x12):

BYTE Mode 00 : Acknowledge for Closing the session
BYTE HostWindow Size of the “window” of messages taken into account
for the Host (1.. 126)
BYTE DeviceWindow Size of the “window” of messages taken into account
for the device (1.. 126)
Link+ (version id=0x02):

BYTE Mode 00 : Acknowledge for Closing the session
With the COMM2004 protocol, the device must acknowledge all the frames sent by the host but the acknowledgement
does not imply that the command is processed. The NOP frame (flush) can be used to solve this problem. When the host
sends a frame to the device, the device replies with the same frame. So, if the host sends a frame that contains a request
and just after it sends a NOP frame, it can be sure that the request has been processed by the device at the moment
where it receives the same NOP frame from the device.
FRAME ID: 0x71 – Request for NOP (HOST  DEVICE)

DWORD dwID Arbitrary ID
FRAME ID: 0xF1 – Reply for NOP (DEVICE  HOST)

DWORD dwID Same arbitrary ID as those of the 0x71 frame sent by the
host
FRAME ID: 0xFF– NACK (DEVICE  HOST)

BYTE FrameNo Number of the frame that has been refused
WORD ErrorCode Error Code (see 4.8)
DWORD AddData Additional data corresponding to the error description
(see 4.8)
BYTE(N) Frame Copy of the packet which has been refused (until the NACK
frame is full)
The NACK frame is sent by the device for different reasons:

- The frame format is not correct
- The command can not be processed (bad parameters, command incompatible with the device state,…)
4.4 Device status
4.4.1 Definition
According to the configuration, the device sent the Device status frame cyclically and/or if a parameter of the frame has
changed. This spontaneous emission stops as soon as a communication session is opened and restarts when the
session is closed.
When no session is opened, the Device status frames are sent without acknowledge with a frame number set to 0.
In case of a clustered architecture, a concentrator is used to transmit the frames of all the devices to the host.
The Device status frames are always sent even if the device is switched off but still plugged to the main supply. If the
device is switched off and not plugged to the main supply, there is no more communication.
FRAME ID: 0x00 – Request for Device status information (HOST  DEVICE)
BYTE byMinDuration Value of the byMinDuration parameter (see below)
BYTE byMaxDuration Value of the byMaxDuration parameter (see below)
The parameters byMinDuration and byMaxDuration are used to specify a cyclical sending of frames (see below).
Note : If the frame is sent to the device without parameter, information are immediately
received through a Device status frame (Frame ID: 0x80).
byMinDuration and byMaxDuration parameters are timing parameters defined in seconds or milliseconds depending on
the range of the value.
49 < byMinDuration or byMaxDuration < 100 in tens of ms (range: 500-990ms)

100 =< byMinDuration or byMaxDuration < 255 in s (range: 1-155s)
byMinDuration or byMaxDuration = 255 transmitted only once (no periodic transmission)
Note : byMinDuration has no effect on the Link+

byMaxDuration has no effect on the Link+
The Link+ does not send frames on event/time.
Different combinations are possible with these 2 parameters:
MinDuration MaxDuration Description
0 0 Stop the periodic and event transmission

Transmission of all events
1 50-254 Transmission when MaxDuration elapsed (refresh)
for Frame ID 0x00 ONLY

Transmission of all events only
1 255
for Frame ID 0x00 ONLY
50-254 == 50-254 Periodic transmission
Transmission
50-254 < 50-254 - if an event occurs and if MinDuration is elapsed
In any case, transmission if MaxDuration elapsed
Transmission
50-254 255 - if an event occurs
- and if MinDuration is elapsed
255 255 Immediate transmission
Any other combination Forbidden
FRAME ID: 0x80 – Device status information (DEVICE  HOST)
Link+ (all version id)

TYPE Name Description Change
BYTE DeviceVersion ID:
0x02 : Link+ (old version)
0x12 : Link+ (new version with Alarm Management)
STRING(4) Version Version of the boot
STRING(4) Version Version of the application
STRING(16) SerialNo Serial number
BYTE Mode 0xFF for boot
0x02 for application
BYTE NbSlots Number of slots
WORD PresentDe Bitfield defining the device presence, i.e. bit0 =
vices Slot1, bit7 = Slot8
WORD Reserved Reserved = 0x00
WORD AlarmActi Bitwise definition of active alarms
ve i.e.
An alarm on Slot1 device sets bit0.
An alarm on Slot2 device sets bit1.
Etc…
BYTE Reserved Reserved = 0x00
Note on Alarmactive:
If an alarm on the device is set and the device is “beeping”, then the rack will set the corresponding bit to 1.
If an alarm on the device is set and the device is not “beeping” (because of SILAL key pressed), then the rack will set the
corresponding bit to 0.
Other devices: Injectomat / Volumat
The table below shows the common information sent by any Agilia devices.
In the Pump status frame, there is a principle of optional data (“subId”).
There is :
- Always a first block of data giving general informations about the device.
- Optional/Required subId’s with specific informations.
First block of data SubId 01 SubId 02 SubId 04 SubId 05

See chapters 4.4.1.1 for Injectomat and 4.4.1.2 for Volumat Optionnal Required Optionnal Optionnal
Note : The content of the Pump status frame depends also on the functioning mode.
In Idle mode (0x01), the Pump status frame is shorter:
First block of data (shorter on Injectomat) SubId 05
See chapters 4.4.1.1 for Injectomat and 4.4.1.2 for Volumat Optionnal
The 4 subIds are:

• subId 01: Patient :see chapter 4.4.2.1
• subId 02: Infusion : see chapter 4.4.2.2
• subId 04: TCI : see chapter 4.4.2.3
• subId 05: Device : see chapter 4.4.2.4
The table below show the availability of subId per device (and software version):
Devices subId 01 subId 02 subId 04 subId 05
Injectomat NA X NA NA
Injectomat MC (version => 3.1) X NA (version => 3.1)
Injectomat TIVA X X (version => 4.0b) X

Volumat X X NA X
Volumat MC X X NA X
4.4.1.1 First Block of Data : Injectomat Agilia
In the following array, the parameters checked with the  symbol are those whose change causes the emission of a
Device status frame if a communication session is not opened.
BYTE Device Type of device:
0x42 : Injectomat Agilia
STRING(4) Version Version of the application: ex. “031A” means 3.1A
STRING(16) SerialNo Complete serial number
DWORD Alarm List of bits which represent the alarms, the pre-alarms
and the information.
Bit 0: alarm “end of limit volume”
Bit 1: alarm “end of volume/time”
Bit 2: alarm “end of infusion”
Bit 3: alarm “battery”
Bit 4: alarm “occlusion”
Bit 5: alarm “syringe clamp”
Bit 6: alarm “flange”
Bit 7: alarm “plunger head”
Bit 8: alarm “disengagement”
Bit 9: always 0
Bit 10: alarm “force sensor” (version => 4.0b)
Bits 11-15: always 0
Bit 16: pre-alarm “end of limit volume”
Bit 17: pre-alarm “end of volume/time”
Bit 18: pre-alarm “end of infusion” 
Bit 19: pre-alarm “battery”
Bit 20: pre-alarm “occlusion”
Bits 21-22: always 0
Bit 23: information “start infusion delayed at end of
pause”
Bit 24: information “infusion flow rate low”
Bit 25: information “infusion flow rate high”
Bit 26: information “syringe empty”
Bit 27: information “power disconnection”
Bit 28: information “rise of pressure”
Bit 29: information “drop in pressure”
Bit 30: information “keyboard locked”
Bit 31: information “night mode”
Bits 0-31 are always set to 0 in case of a device in
idle mode (spontaneous frame)
BYTE Error 0 in normal use, or an error code in case of technical
error
Always 0 in case of a device in idle mode (spontaneous 
frame)
BYTE SilalCnt Number of use of the Silence Alarm (SILAL) button
frame)
DWORD Internal Internal date and time (number of seconds elapsed since
the 01/01/1970)
BYTE OperMode Functional Mode (same as those described above with 2
additional modes : 00 and FE):
01: idle mode: device in idle mode and connected to the 
main supply
02: ON: device switched on
BYTE Status Status of the device:
0x04 : idle mode 
0x06 : Switched on
BYTE Step Actual step of the device:
00: Other (configuration menu: User, Ward, Maintenance
01: Syringe selection
02: Wait for prime (mandatory or recommended prime)
03: Flow rate selection (infusion stopped)
83: Flow rate selection (infusion in progress)
04: Drug selection
On
05: Volume/time programming defined in the drug
Injectomat,
06: loading dose selection (only for MC and above)
not present
07: waiting for loading dose launching (only for MC and
if
above)
OperMode=0x1
08: programmed bolus selection, infusion not in progress
and
(only for MC and above)
Status=0x4
88: programmed bolus selection, infusion in progress
(only for MC and above)
09: waiting for programmed bolus launching, infusion not
in progress (only for MC and above)
89: waiting for programmed bolus launching, infusion in
progress (only for MC and above) 
0A: Simple bolus flow rate selection (infusion stopped)
8A: Simple bolus flow rate selection (infusion in
progress)
0D: Waiting before launching infusion
0F: Menu (infusion stopped)
8F: Menu (infusion in progress)
10: Infusion
11: Simple bolus since stop
91: Simple bolus since infusion
13: Prime
20: Stop
21: occlusion
22: KVO1 infusion
23: Error (related to a technical error)
24: Pause
30: Booting steps (from “displaying info” to “syringe
selection’)
FF: Unknown
WORD Status Status of the device: (list of bits)
Bit 0: Beep for information, pre-alarms, alarms, error
or non-validating activated
On
Bit 1: alarm present
Injectomat,
Bit 2: pre-alarm present 
not present
Bit 3: information present
if
Bit 4: infusion in progress (except purge)
OperMode=0x1
Bit 5: plugged to the main supply
and
Bit 6-15: always 0
Status=0x4
BYTE Mode Infusion mode:
00: Unknown (stanby)
01: Basic infusion
02: Volume/time
On
03: Simple Bolus
Injectomat,
not present
04: Prime 
05: Manual bolus
if
06: Testing function
OperMode=0x1
07: Loading dose (version => 3.1)
and
08 : Programmed bolus (version => 3.1)
Status=0x4
09 : TCI mode (version => 4.0t)
1 KVO (Keep Vein Opened): a minimal infusion flow rate can be maintained to avoid a vein occlusion caused by the blood coagulation.
4.4.1.2 First Block of Data : Volumat Agilia
In the following array, the parameters checked with the  symbol are those whose change causes the emission of a
Device status frame if a communication session is not opened.
BYTE Device Type of device:
0x44 : Volumat Agilia
STRING(4) Version Version of the application: ex. “011A” means 1.1A
STRING(16) SerialNo Complete serial number
DWORD Alarm List of bits which represent the alarms, the pre-alarms
and the information.
Bit 0 : clamp missing
bit 1 : end of infusion alarm
bit 2 : end of secondary infusion alarm (version =>
2.1c)
bit 3 : battery alarm
bit 4 : downstream occlusion alarm
bit 5 : door opened alarm
bit 6 : set not detected by downstream pressure sensor
bit 7 : set not detected by upstream pressure sensor
bit 8 : set not installed correctly
bit 9 : upstream occlusion alarm
bit 10 : upstream occlusion alarm
bit 11 : uncontrolled flow alarm
bit 12 : occlusion detected by drop sensor
bit 13 : under flow alarm detected by drop sensor
bit 14 : over flow alarm detected by drop sensor
bit 15 : absence of drop sensor
bit 16 : drop sensor has been connected during infusion 
bit 17 : Air alarm (air presence or air detection
failure)
bit 18 : Air alarm (air volume exceeded limit)
bit 19 : end of infusion pre-alarm
bit 20 : battery pre-alarm
bit 21 : downstream occlusion pre-alarm
bit 22 : low flow rate or low dose
bit 23 : high flow rate or high dose
bit 24 : occlusion check system failed
bit 25 : infusion delayed during pause
bit 26 : presence of drop sensor
bit 27 : main disconnection
bit 28 : pressure increase
bit 29 : pressure drop
bit 30 : keyboard locked
bit 31 : night mode
Bits 0-31 are always set to 0 in case of a device in
idle mode (spontaneous frame)
BYTE Error 0 in normal use, or an error code in case of technical
error
frame)
BYTE SilalCnt Number of use of the SILAL button
frame)
DATETIME Internal Internal date and time (number of seconds elapsed since
the 01/01/1970)
BYTE OperMode Functional Mode (same as those described above with 2
additional modes : 00 and FE):
01: Idle mode: device in idle mode and connected to the 
main supply
02: ON: device switched on
BYTE Status Status of the device:
0x04 : Idle mode 
0x06 : Switched on
BYTE StepStatus Actual step of the device:
00: Other (configuration menu: User, Ward, Maintenance)
01: alarm display
03: Flow rate selection (infusion stopped)
83: Flow rate selection (infusion in progress)
04: Drug selection
05: Volume/time programming defined in the drug
06: Loading dose selection
07: waiting for loading dose start
0A: Simple bolus flow rate selection (infusion stopped)
8A: Simple bolus flow rate selection (infusion in
progress)
08: Programmed Bolus flow rate selection (infusion
stopped)
88: Programmed Bolus flow rate (infusion in progress)
09: Waiting for start of Programmed Bolus
89: Waiting for start of Programmed Bolus ( infusion in
progress)
0B: Secondary drug selection
0D: Waiting before launching infusion 
0F: Menu (infusion stopped)
8F: Menu (infusion in progress)
10: Infusion (including loading dose and programmed
bolus)
11: Simple bolus infusion when stop state
91: Simple bolus infusion during an infusion
13: Prime
14: Air prime
20: infusion stopped
21: occlusion
22: KVO2 infusion
23: Error (related to a technical error)
24: Pause
30: Boot phase (from “displaying info” to “syringe
selection’)
31: Patient confirmation
15: occlusivity check
FF: Unknown
WORD SumStatus Status of the device: (list of bits)

Bit 0: Beep for information, pre-alarms, alarms, error
or non-validating activated
Bit 1: alarm present
Bit 2: pre-alarm present 
Bit 3: indication present
Bit 4: infusion in progress (except purge)
Bit 5: plugged to the main supply
Bit 6-15: always 0
2 KVO (Keep Vein Opened): a minimal infusion flow rate can be maintained to avoid a vein occlusion caused by the blood coagulation.
BYTE InfusMode Infusion mode:
01: Volume/time
02: Volume/rate
03: Time/rate
04: Volume/time/rate
05: Rate
06: drops/minute (Volumat MC)
07: bolus
08: secondary (Volumat MC) 
09: loading dose
10: programmed bolus
11: ramp (Volumat MC)
12: sequence (Volumat MC)
13: air prime
14: prime
15: testing function
Bit 7: macro/micro mode
4.4.2 Volumat and Injectomat Device status SubId

4.4.2.1 Patient SubId
TYPE Name Description Rem
SubId 01: Patient
BYTE PatientZoneSize Size of the data from the <
bySubIdPatient > field to the end of -
the block.
BYTE SubIdPatient ID = 01 -
DATETIME CreatePatient Date of patient creation -
VSTRING(30) PatientLastName Patient last name
Empty Frame when no patient: -
size 1, value “00”
VSTRING(30) PatientFirstName Patient first name
DWORD PatientWeight Patient weight
-
Unit: gram
WORD PatientAge Patient age
Unit : month (12 to 1800) -
0 : unknown
BYTE PatientGender Patient gender
0 : unknown
-
1 : male
2 : female
VSTRING(30) PatientCode Patient code ID
WORD PatientHeight Patient height Field NOT
0 : unknown applicable to
Unit : centimeter Volumat
WORD Bsa Patient Body Surface: Field NOT
0 : unknown applicable to
Unit : 1/1000 of squaremeter Volumat
4.4.2.2 Infusion SubId
TYPE Name Description Rem
SubId 02: Infusion
BYTE SubIdInfusionZone Size of the data from the < bySubIdInfusion >
Size field to the end of the block.
BYTE SubIdInfusion ID = 02
DWORD FlowRate Current real flow rate (1/1000 units).
0 if infusion stopped, or if occlusion release
Units : ml/h or doserate (depends on device
operating mode)
STRING(20) DrugName Drug name or empty string if no drug is
selected
UNIT FlowRateUnit Flow rate unit : ml/h or doserate (depends on
device operating mode)
DWORD Volume Infused volume (1/1000 ml). This value is
reset to 0 only after the value has reached
FFFFFFFFh. It is not if the infused volume has
been reset from the keyboard. There is also no
reduction in case of occlusion release.
WORD Pressure Pressure in the syringe / tubing set (mmHg)
DWORD Dilution Drug dilution (1/1000 units). 0 if no drug is
selected or if drug has no dilution.
UNIT DilutionUnit Dilution unit. 0 if no drug is selected or if
drug has no dilution.
WORD VolDilution Volume associated to the dilution (ml).
0 if no drug is selected or if drug has no
dilution.
DWORD LeftVolume Volume left (to be infused) in the syringe
(1/1000 ml) or in the primary infusion (even
if secondary infusion is active).
BYTE SyringeSize Syringe size (in ml). 0 if no syringe is
selected.
Always 0 if volumetric pump
STRING(20) SyringeName Syringe/TubingSet name or empty string if no
or TubingSetName syringe/tubing is selected.
DWORD UserVolume Infused volume (1/1000 ml). This value is
reset to 0 after the value has reached 9999999
or if the infused volume has been reset from
the keyboard. This volume could be decreased
during occlusion release.
FFFFFFFFh if secondary volume infusion option
is on.
DWORD UserMass Mass infused (1/1000 unit). “0” if not in dose
rate mode. If UserMass>=MAX_DWORD, the prefix
unit is updated. This value is reset to 0 if
the infused volume has been reset from the
keyboard.
UNIT UserMassUnit Unit of the mass infused. 0 if not in dose
rate mode.
DWORD UserVolumePri Infused primary volume (1/1000 ml). This value
is reset to 0 after the value has reached
9999999 or if the infused volume has been
See Note
reset from the keyboard. This volume could be
below
decreased during occlusion release.
is off.
DWORD UserVolumeSec Infused secondary volume (1/1000 ml). This
value is reset to 0 after the value has
reached 9999999 or if the infused volume has
See Note
been reset from the keyboard. This volume
below
could be decreased during occlusion release.
is off.
NOTE on UserVolume, UserVolumePri and UserVolumeSec:
Device status SubId 02

Devices
UserVolume UserVolumePri UserVolumeSec
Devices
Availability Availability Availability
Injectomat X
Injectomat MC X
Injectomat TIVA X
Volumat X
Volumat MC X >=2.2b >=2.2b
4.4.2.3 TCI SubId

SubId 04: TCI
BYTE TciZoneSize Size of the data from the < bySubIdTci > field
to the end of the block.
BYTE SubIdTci ID = 04
DWORD Plasma Current Plasma Concentration (1/1000 units)
DWORD Effect Current Effect Concentration (1/1000 units)
DWORD Target Target Concentration (1/1000 units)
UNIT Unit Target, Effect and Plasma concentration unit
BYTE TciMode Tci Mode:
01: Plasma
02: Effect
4.4.2.4 Device SubId

SubId 05: Device
BYTE DeviceZoneSize Size of the data from the < bySubIdDevice >
field to the end of the block.
BYTE SubIdDevice ID = 05
BYTE SubDevice Subdevice identifier
0x00: standard
0x20: dose rate
0x40: TIVA (only for device = 0x42, Agilia
syringe pump)
4.5 Device information
The following frame is used to retrieve the device version.
FRAME ID : 0x40 – Request for device information (HOST  DEVICE)

BYTE DataId DataId = 1
This frame can be used with pumps (all types) and Link+ (id=0x12 only).
Frame example:
40 01
The following frame is sent by the device.
FRAME ID : 0xC0 – Device information (DEVICE  HOST)

BYTE Size Size of the data (<DataId> + <Data>)
BYTE DataId Id of the data
ABYTE (Size – 1) Data Data
For the Pumps:

< Data > field contains:
Data ID-01: Identification of the application

DATETIME Create Creation date/time of the application
WORD CRC16 CRC (16 bits) of the application
STRING(4) Version Version of the application
For the Link+ (id=0x12)

< Data > field contains:
Data ID-01: Identification of the application

Version of the application
Example:
STRING(32)
Version “3.0 / BW_rel_D14”
“Commercial Version / Internal Version”
4.6 Additional infusion information
4.6.1 Advanced data infusion reading

The following frame can be sent by the host to the device to get advanced infusion data such as bolus volumes (simple,
manual, programmed, loading dose) and infused volume.
The values in these frames shall not be used when the pump is in idle mode: OFF / OperMode=0x1 and Status=0x4
(see 4.4.1.1 and 4.4.1.2)
FRAME ID: 0x5F – Request for advanced infusion data (HOST  DEVICE)

BYTE DataID List of dataID
BYTE MinDuration Value of the MinDuration parameter (see Frame Id 0x00
above)
BYTE MaxDuration Value of the MaxDuration parameter (see Frame Id 0x00
above)
Note : If this frame is sent without parameter, no reply is sent by the device and all
spontaneous frames ID 0x5F are no more sent.
In response to this frame the following frame is sent by the device to the host:
FRAME ID: 0xDF – Advanced infusion data (DEVICE  HOST)

DWORD SampleTime Creation date of the frame by the device
Unit : 10ms
BYTE Size Size of the data from <DataID> to < Data > (including
optional data if provided)
0 to indicate the end of the emission of data (in this
case, DataID and Data are missing)
The number of parameters to decode depends on this
size information. (no other way to detect optional
data in the DF frames)
BYTE DataID ID of Data (see below)
Data Data associated to Id (see below)
4.6.2 List of DataId
4.6.2.1 Flowrate
BYTE Flowrate ID of the flowrate: always 0x07
SDWORD Data Value of the flowrate (1/1000 ml/h)
0 if infusion is stopped
Negative if release occlusion
4.6.2.2 Infused Volume

BYTE InfusedVolume ID of the infused volume: always 0x0C
DWORD Data Value of the infused volume (1/1000 ml)
Optional Data:
DWORD Mass Total infused mass, 1/1000 unit
UNIT MassUnit Total infused mass unit
4.6.2.3 Manual Bolus

BYTE ManualBolus ID of the manual bolus: always 0x0E
DWORD VolBolus Infused volume for manual bolus, increase from 0 after
each start of new manual bolus
DWORD VolTot Infused volume for manual bolus, 1/1000 ml
Optional Data:
DWORD Mass MassBolus : infused mass for manual bolus, 1/1000
unit, increase from 0 after each start of new manual
bolus
UNIT MassBolusUnit Mass unit
4.6.2.4 Simple Bolus

BYTE SimpleBolus ID of the simple bolus: always 0x10
DWORD Flowrate simple bolus flowrate, 1/1000 ml/h
DWORD Volume Infused volume for simple bolus, 1/1000 ml, increase
from 0 after each start of new simple bolus
Optional Data:
DWORD Mass MassBolus : infused mass for simple bolus, 1/1000
unit, increase from 0 after each start of new simple
bolus
UNIT MassBolusUnit Mass unit
4.6.2.5 Loading Dose

BYTE LoadingDose ID of the loading dose: always 0x4D
DWORD FlowRate Infusion flowrate, nl/h
DWORD Volume Remaining volume to infuse, 1/1000 ml
DWORD Duration Remaining infusion duration, s
Optional Data:
DWORD MassToInfus Remaining mass to infuse, 1/1000 unit
UNIT MassToInfusUnit Mass unit
4.6.2.6 Programmed Bolus
BYTE ProgrammedBolus ID of the programmed bolus: always 0x4E
DWORD FlowRate Infusion flowrate, 1/1000 ml/h
DWORD Volume Remaining volume to infuse, 1/1000 ml
DWORD Duration Remaining infusion duration, s
Optional Data:
DWORD MassToInfus Remaining mass to infuse, 1/1000 unit
UNIT MassToInfusUnit Mass unit
4.6.2.7 Availability of DataId
DataId 07 DataId 0C Data 0E DataId 10

Devices
FlowRate Infused volume Manual bolus Simple bolus
Injectomat X X X X
Injectomat MC X X X X
Injectomat TIVA X X X X
Volumat X X X
Volumat MC X X X
DataId 4D DataId 4E
Devices
Loading Dose Programmed Bolus
Injectomat
Injectomat MC X X
Injectomat TIVA X X
Volumat
Volumat MC X X
A manual bolus is a forbidden operation which consists in pushing the plunger manually.
A simple bolus is done by pressing the bolus key on the device.
4.7 IP Address
The following frame is used to retrieve the device IP address.
The following frame is only available for Link+, Version ID 0x12, Software Version >= BW_rel_D8
FRAME ID : 0x64 – Request for IP adress (HOST  DEVICE)

BYTE DataId DataId = 1
Frame example:
64 01 01
FRAME ID : 0xE4 – IP address (DEVICE  HOST)

STRING(15) Value IP address (“###.###.###.###”)
4.8 Error Codes
Here is the list of all the possible error codes:
Error
Error Type Description
Code
01 ERRCLOSE Communication session not opened
02 ERROPEN Communication session still opened
03 ERRID Frame ID unknown
04 ERRIDMODE Frame ID not allowed in the current functional mode
05 ERRIDSTATE Frame ID not allowed in the current state of the device
06 ERRFUNCID Function ID unknown
07 ERRFUNCMODE Function ID not allowed in the current functional mode
08 ERRFUNCSTATE Function ID not allowed in the current state of the device
09 ERRDATAID Data ID unknown
0A ERRVALIDMODE Forbidden requested functional mode
0B ERRMODE Incorrect requested functional mode
0C ERRSIZE Incorrect package size
0D ERRSUBSIZE Incorrect sub-package size
0E ERRZONEID Incorrect Zone ID
0F ERRPARID Incorrect Parameter ID
10 ERRPARINDEX Incorrect index of an element in an array of parameters
Incoherent or out of limits parameter (only for Frame ID 0x02).
Additional Data:
Bits 24-31: error type:
• 0x01: the value is not between the maximum and the minimum
values:
- bits 0-7: field number in the parameter or sub-parameter
- bits 8-15: parameter id, or 0 if no sub-parameter
- bits 16-23 : always 0
• 0x02: incorrect value (if the allowed configuration rule is
more complicated than a simple test of a value between a minimum
and a maximum):
- bits 0-7: field number in the parameter or sub-parameter
11 ERRLIMIT - bits 8-15: parameter id, or 0 if no sub-parameter
• 0x04: incoherence between some values:
- bits 0-7 : type of incoherence :
1: Unit without volume and unit different from 0
2: Minimum value > default value
3: Default value < maximum value
4: Minimum value > maximum value
5: 2nd minimum value > 2nd default value (see the vol_time
parameter)
6: 2nd default value < 2nd maximum value (see the vol_time
parameter)
7: 2nd minimum value > 2nd maximum value (see the vol_time
parameter)
8: Minimum volume/time flow rate too big
9: Maximum volume/time flow rate too small
10: Default volume/time flow rate too small or too big
11: Default infusion mode forbidden
- bits 8-15: parameter id, or 0 if no sub-parameter
• 0x08: a mandatory parameter is absent:
- bits 0-7 :always 0
- bits 8-15: id of the absent parameter
• 0x10: incoherence detected by a validation function
12 ERRSTORING Configuration storing in progress
13 ERRALARM Alarm present
Problem in the selection of the syringe.
Additional Data :
1: The syringe is not configured
2: The syringe is not selectable
3: The type of syringe is not recognised
14 ERRSYSINGE 4: The external diameter of the syringe is not correct
5: The field <Step1ml> is incoherent
6: Problem with the maximum period at the minimum flow rate
7: Problem with the maximum period (battery) at the minimum
flow rate
8: Problem with the maximum period (main supply) at the
minimum flow rate
15 ERRSPONT Spontaneous emission not possible
16 – 19 - Error codes used by Boot
1A ERRDRUG Problem in the frame 0x02 with a drug definition
Incorrect sub-parameter size in a parameter with a variable
1B ERRPARSUBSIZE
length
1C ERRPARNOSUB No mandatory sub-parameter set in a parameter
1D ERRPARFULL Storing memory full (for the drug parameters)
4.9 Types of variables
TYPE Size of (type)

BYTE / ABYTE 8 bits (unsigned)
SBYTE 8 bits (signed)
WORD / AWORD 16 bits (unsigned)
SWORD 16 bits (signed)
DWORD 32 bits (unsigned)
SDWORD 32 bits (signed)
QWORD 64 bits (unsigned)
STRING(n) 8n bits
VSTRING(n) 8n bits
UNIT 16 bits (see 3.2.1 Units Encoding for definition)
DATETIME 32 bits (see 3.2.2 Dates for definition)
Note :
STRING: the first character can be an escape code defining the string encoding. By default, a STRING is encoded in
CP1252 but other codepages possible. The list below is not exhaustive.
VSTRING are string with variable size length. The parameter is the maximum size length. The difference is about the
memory footprint.
Example:
VSTRING(30) Name = “dupont\0”, strlen(Name) == 7.
STRING(30) Name, strlen(Name) == 30
01h: CP1251
02h: CP1252
03h: CP1253
04h: CP1254
05h: CP1255
06h: CP1256
07h: CP1257
08h: CP1259
10h: CP1250
11h: CP874
5. Volumes Displayed on Screen vs API
Information about the different Volumes are available in Device: Infusion SubId 0x02
Volume shall not be used

This value is never displayed on the pump.
This value does not represent what has been infused to the patient.
This value represents all the fluid the pump as pushed in the line since power on.
This value is equal or greater than the volume infused to the patient.
UserVolume is the Volume Infused

This value is the Volume Infused into the patient’s body
This value may be displayed on the pump’s screen as « VI » (Volume Infused), depending on the configuration and the mode
of the pump.
This value is reset to 0 after the value has reached 9999999, or if the infused volume has been reset from the keyboard.
This value will be decreased during occlusion release.
This value will be set to FFFFFFFFh if secondary volume infusion option is on (see blelow)
UserMass is the Dose Infused

This value may be displayed on the pump’s screen as « DI » (Dose Infused), depending on the configuration and the mode of
the pump.
LeftVolume: is the Remaining Volume

This value may be displayed on the pump’s screen, depending on the configuration and the mode of the pump.
On a Volumat:
If primary/secondary mode is activated, please use UserVolumePri and UserVolumeSec
UserVolumePri will be displayed on the pump as « Pri VI »
User VolumeSec will be displayed on the pump as « Sec VI »
6. Decimal Place Rules for Values displayed on Screen
6.1 Injectomat - Flow Rate / Dose Rate
6.1.1 Macro Mode

6.1.1.1 Drug is programmed with a Flow Rate (mL/h)
API Display
0 to MAX mL/h 1 decimal place (0.1)
6.1.1.2 Drug is programmed with a Dose Rate (NOT mL/h)

API Display Dose Rate Display Flow Rate
0 to 10 (excluded) 2 decimal places (0.01) 1 decimal place (0.1)
10 to 1000 (excluded) 1 decimal place (0.1) 1 decimal place (0.1)
1000 and above 0 decimal place (1) 1 decimal place (0.1)
6.1.2 Micro Mode

API Display
0 to 10 (excluded) 2 decimal places (0.01)
10 to MAX mL/h 1 decimal place (0.1)

0 to 10 (excluded) 2 decimal places (0.01) 2 decimal places (0.01)
1000 and above 0 decimal place (1) 1 decimal place (0.1)
6.2 Injectomat - Concentrations
API Display Concentration Display Flow Rate
0 to 10 (excluded) 2 decimal places (0.01)
100 and above 0 decimal place (1)
6.3 Volumat - Flow Rate / Dose Rate
6.3.1 Macro Mode

API Display
0 to MAX mL/h 0 decimal place (1)

0 to 10 (excluded) 2 decimal places (0.01) 0 decimal place (1)
10 to 100 (excluded) 1 decimal place (0.1) 0 decimal place (1)
100 and above 0 decimal place (1) 0 decimal place (1)
6.3.2 Micro Mode

API Display
0 to 100 (excluded) 1 decimal place (0.1)
100 to MAX mL/h 0 decimal place (1)

0 to 10 (excluded) 2 decimal places (0.01) 1 decimal place (0.1)
100 and above 0 decimal place (1) 0 decimal place (1)
6.4 Volume - Dose
Volume Macro Mode Micro Mode Nota
UserVolume 0 decimal place (1) 1 decimal place (0.1) Volumat
(displayed as “VI”) 1 decimal place (0.1) <10 mL: 2 decimal places (0.01) Injectomat
>=10 mL: 1 decimal place (0.1)
UserVolumePri 0 decimal place (1) 1 decimal place (0.1) Volumat
Only
(displayed as “Pri VI”)
UserVolumeSec 0 decimal place (1) 1 decimal place (0.1) Volumat
Only
(displayed as “Sec VI”)
LeftVolume 0 decimal place (1) 0 decimal place (1) -
UserMass 2 decimal places (0.01) 2 decimal places (0.01) Volumat
(displayed as “DI”) <10 Units: 2 decimal places (0.01) <10 Units: 2 decimal places (0.01) Injectomat
>=10 Units: 1 decimal place (0.1) >=10 Units: 1 decimal place (0.1)
7. Rouding Rules for Values displayed on Screen
7.1 Flowrate / DoseRate / Concentration
0 decimal place (1) 1 decimal place (0.1) 2 decimal place (0.01)

API Display API Display API Display
< X,5 X < X,Y5 X,Y < X,YZ5 X,YZ
>= X,5 X+1 >= X,Y5 X,(Y+1) >= X,YZ5 X,Y(Z+1)
10.000 10 10.100 10.1 10.1200 10.12
10.251 10 10.120 10.1 10.1249 10.12
10.499 10 10.149 10.1 10.1250 10.13
10.500 11 10.150 10.2 10.1272 10.13
10.666 11 10.166 10.2 10.1299 10.13
10.999 11 10.199 10.2 - -
7.2 Volumes / Dose

Volume Macro Mode Micro Mode
UserVolume (displayed as “VI”) FLOOR FLOOR
ROUNDING ROUNDING
UserVolumePri (displayed as “Pri VI”) API  Display API  Display
UserVolumeSec (displayed as “Sec VI”) 151,0  151 153,80  153,8
151,2  151 153,82  153,8
UserMass (displayed as “DI”) 151,5  151 153,85  153,8
151,9  151 153,89  153,8
LeftVolume CEILING ROUNDING
API  Display
150,0x  150
150,2x  151
150,5x  151
150,9x  151
8. Local contacts for servicing
This document may contain inaccuracies or typographical errors.
Modifications may therefore be made and will be included in later editions.
Due to changing standards, legislation and material, the characteristics indicated by the text and the images of this
document are applicable only for the device that it accompanies.
This document may not be reproduced in whole or in part without the written consent of Fresenius Kabi.
Agilia® is a registered trademark by Fresenius Kabi in selected countries.
Revision date: see “Revision List”
Fresenius Kabi AG
D-61346 Bad Homburg
Marking in conformity to the
Germany essential requirements of the
www.fresenius-kabi.com 93/42/CEE directive.

CC2777-11 Serial Export Protocol Agilia Range Eng

Uploaded by

Copyright:

Available Formats

CC2777-11 Serial Export Protocol Agilia Range Eng

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

CC2777-11 Serial Export Protocol Agilia Range Eng

Uploaded by

Copyright:

Available Formats

Serial Export Protocol

FOR AGILIA RANGE

Device Software Version

Injectomat TIVA up to 4.3h

Link+ (type 0x12) up to 3.0 (D14)

Link+ (type 0x02) up to 2.11

Date Rev. Modifications

Jan. 05th 2015 8 CR8555 :

3.1 Frame format

START TYPE NO ACK SZ CRC8 ID DATA CRC16

Description of the different fields of such a frame:

Definition of field Type :

3.2.1 Units Encoding

START TYPE NO ACK SZ CRC8

BYTE Comm_CalcCrc8( const BYTE * i_pbyBuffer, int i_iSize )

START TYPE NO ACK SZ CRC8 ID DATA CRC16

▪ The algorithm used is described below :

Frame description (see frame 0x70 § 0 for the data description):

11 00 Frame Data: Disconnect Behaviour = do nothing when disconnected

HOST SERIAL LINK DEVICE

Frame3 Frame3  No Reply Ack3

Frame4 Frame4  Reply

HOST SERIAL LINK DEVICE

Automatic repetition of frames 2, 3 and 4

Frame3 Frame3  No Reply Ack3

Ack2 Frame4 Frame4  Reply4

Treatment of frame #03

Transmission of a empty frame, without frame number, to maintain the

The same for DEVICE

Example of a communication without re-emission of the frame:

t < PacketRepeatTimeout_ms  no re-emission of the frame

Example of a communication with re-emission of the frame:

Example of bad frame reception: incorrect CRC

3.6.4 Recommendations when using Pumps plugged on a Link+

4.1 Session Layer

4.1.1 Start of communication

4.1.2 End of communication

4.1.3 Errors management

Code (hexa) Functional Mode

Here is the list of commands and messages:

Injectomat / Volumat / Link+ (all versions):

Injectomat / Volumat / Link+ (all versions):

Injectomat / Volumat / Link+ (version id=0x12):

Link+ (version id=0x02):

TYPE Name Description

FRAME ID: 0xF1 – Reply for NOP (DEVICE  HOST)

TYPE Name Description

FRAME ID: 0xFF– NACK (DEVICE  HOST)

TYPE Name Description

The NACK frame is sent by the device for different reasons:

49 < byMinDuration or byMaxDuration < 100 in tens of ms (range: 500-990ms)

Note : byMinDuration has no effect on the Link+

0 0 Stop the periodic and event transmission

1 50-254 Transmission when MaxDuration elapsed (refresh)

for Frame ID 0x00 ONLY

Any other combination Forbidden

Link+ (all version id)

First block of data SubId 01 SubId 02 SubId 04 SubId 05

The 4 subIds are: