P R O T O C O L D E S C R I P T I O N S HLD6000 Product description Type designation Interface Protocols Catalog no. 510-025, 510-027, 510-028 from software version 1.12 Document no.
This document applies to the software version stated on the cover page. If you need a different version, please contact our sales staff. Reprint, translation and duplication need to be approved in writing by INFICON GmbH.
Content 1 Interface Protocols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 1.1 1.2 1.3 2 ASCII Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 2.1 2.2 2.3 2.4 2.5 3 3.3 3.4 3.5 Communication Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 Command Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 3.2.1 Telegram Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1 Interface Protocols 1.1 Serial Interface Protocols With the IO1000 module you can communicate with the HLD6000 via the following serial interface protocols: • ASCII Protocol (enabled by default) • LD Protocol If you want to replace a HLD5000 with a HLD6000 you can also use • Protocol "Simple" • Protocol "Normal" The interfaces protocols "Simple" and "Normal" are not described in this document. Please refer to the "HLD5000 Interface Description".
Now: Last 3 digits are error number, no message type 1.2.
1.
2 ASCII Protocol 2.1 Communication Parameters Data format 19200 baud, 8 data bits, no parity, 1 stop bit 2.2 Command Format In ASCII protocol any command starts with « * » (ASCII code 42dec/2Ahex) and is finished with the end sign CR (ASCII code 13dec/0Dhex). There is no differentiation between upper and lower case. A blank is required between the command and the parameter, no other blanks are allowed. There is a short and an extended form of the command.
2.3 Commands Relates Read / to LD Write cmd. no. W Command Meaning *BEEP Output beep sound.
Command Meaning *CONFig:STANDBYDel *CONFig:TRIGger1 Auto standby time in minutes 1…15, 0=OFF desired trigger1 in selected unit Relates Read / to LD Write cmd. no.
Relates Read / to LD Write cmd. no.
Command Meaning *MEASure:U3V3 *MEASure:U5 *MEASure:UIRSOURCE *MEASure:UPROBE *READ *READ:G/a *READ:LB/yr *READ:MBAR*l/s *READ:OZ/yr *READ:PA*m3/s *RST:CALHistory *RST:ERRORHistory *RST:FACTORY *SERVICE:READBuffer +3.
Command Meaning *STATus:CAL status of calibration: READY WAIT_STABLE_INT_CAL PHASE_INT_CAL FACT_INT_CAL KEEP_PROBE_STILL_INT_CAL WAIT_STABLE_PROOF ACK_NACK_PROOF KEEP_PROBE_STILL_PROOF WAIT_STABLE_EXT_CAL PHASE_EXT_CAL FACT_EXT_CAL EEP_PROBE_STILL_EXT_CAL PHASE_CAL_CO2 LEAK_CAL_CO2 PROBE_NOT_STILL_CAL_CO2 AIR_START_CAL_CO2 AIR_CAL_CO2 PROBE_NOT_STILL_AIR_CAL_CO2 RESULT_OK RESULT_TOO_HIGH RESULT_TOO_LOW PROOF_OK PROOF_NOT_OK PROOF_IMPOSSIBLE EXTERN_NOT_STABLE TIMEOUT RESULT_OFFSET_TOO_HIGH RESULT_DIFFEREN
Command *STATus:ERRor:TEXT *STATus:LEAK:Gas *STATus:LEAK:LREff *STATus:LEAK:LRNom *STATus:LONGTERMHist Relates to LD cmd. no. Text of the actual error / warning 294 Gas type of internal reference leak 457 internal reference leak temperature compensated in g/a 394 internal reference leak nominal in g/a 394 341 long term history Meaning Read / Write R R R R R internal index (0...
Command Meaning *STATus:WARNINGBits Warning-Bits which indicate pending warnings: WARNING_MAIN_EEPROM = 0x00000001 WARNING_LAMP = 0x00000002 WARNING_MAIN_TEMP = 0x00000010 WARNING_CAL_REQUEST = 0x00000020 WARNING_RTC = 0x00000040 WARNING_PROBE_COM = 0x00000080 WARNING_DIFF_PRESS = 0x00000100 WARNING_IO_DISCONNECT = 0x00000200 WARNING_PROBE_SUPPLY = 0x00000400 WARNING_I_MOD = 0x00000800 WARNING_PROBE_NO_ANSWER = 0x00001000 WARNING_PROBE_PARA = 0x00002000 WARNING_LEAK_EMPTY = 0x00004000 WARNING_LEAK_NEARLY
2.4 Examples External Calibration To execute an external calibration via ASCII-protocol proceed as follows: 1 Move sniffer to external leak 2 Start calibration with command *CAL:EXT 3 Wait until leack rate signal is stable 4 Acknowledge stable signal with command *CAL:ACK 5 Poll *STATUS:CAL? Until it answers "RESULT_OK" 6 Remove sniffer from external leak 2.5 Command *stat? (CR) *status? (CR) *read? (CR) answer MEAS (CR) MEAS (CR) 2.876E-7 (CR) *read:pa*m3/s? (CR) *start (CR) 2.
3 LD Protocol 3.1 Communication Parameters Data format Baudrate 3.2 Command Format 3.2.1 Telegram Structure 19.
Command Meaning DATA Data belonging to master request (Slave reply to write command is sent without data) 0 ≤ n ≤ 248 If I/O module (7-byte additional header) is used, then limit maximum data length to 241. CRC Checksum Calculate CRC for all bytes (except CRC byte) Polynomial: 0x98, Name: DOWCRC, Maxim/Dallas, X8+X5+X4+1 Info: CRC calculation see document "CRC_calculation.c" (C souce code) Cmd H/L: Command: Command-specifier Bit 15 ...
Command info 1. Byte Data type (see table “Data types”) 2. Byte Number of array elements: 0 = no data, no array 1 = data, no array 2 ... 255 = array 3. Byte Bit 0: 1 = Reading allowed, 0 = Reading not allowed Bit 1: 1 = Writing allowed, 0 = Writing not allowed Bit 2 ...
3.3 Status Word Status word bit no. Bit 0 Bit 1 Bit 2 Bit 3 Bit 4 Bit 5 Bit 6 Bit 7 Bit 8 Bit 9 Bit 10 Bit 11 Bit 12 Bit 13 Bit 14 Bit 15 Meaning Device state: 0 = Runup 1 = Standby 2 = Measure 3 = Calibration internal 4 = Calibration external 5 = Proof 6 = Not used 7 = Not ready not used not used Still pending device warning. Is 1 even if warning is confirmed via command "Clear error" (Command No. 5) as long as reason for warning still exists.
3.4 Commands Command Class Name dez hex 0 0 Control NOP R/W Data type Description R NO_DATA "No operation", replies without data 1 2 4 1 2 4 Control Start Control Stop Control Calibration W W W NO_DATA Switch from "standby" to "measure" NO_DATA Switch from "measure" to "standby" NO_DATA Start calibration with ext. Testleak 5 11 5 B Control Clear error Control Calibration acknowledge W W 128 129 142 80 81 8E Meas Meas Meas Leak rate [sel.
Command Class Name dez hex 260 104 Status State calibration R/W Data type Description R UINT8 261 105 Status PLC input state IO module R/W UINT16 262 106 Status PLC output state IO module R UINT8 Status of calibration 0 = Ready 1 = Internal CAL: Wait for stable signal 2 = Internal CAL: Phase calculation 3 = Internal CAL: Factor calculation 9 = Internal CAL: Messgae: "Please keep Probe still" 11 = Proof: Wait for stable signal 13 = Proof: Colculation if value is OK or not OK 19 = Proof: Message:
Command Class Name dez hex 263 107 Param PLC output configuration IO module 274 22 112 Status Last entry in cal history LD Protocol R/W Data type Description R/W SINT8[8] UINT8 Index 0...7 = PLC_OUT1 ...
Command Class Name dez hex 275 113 Status Cal history R/W Data type Description CHAR[*] 277 115 Status Last entry in error history R UINT8 287 11F Status Error history R CHAR[*] 289 121 Status Value of actual error R FLOAT 290 294 122 126 Status Number of actual error Status Text of error number R R UINT16 CHAR[*] 295 127 Status Text of warning bits R 296 128 Status List of active errors R Text of calibration in the history list.
Command Class Name dez hex 297 129 Status Present warnings R UINT32 300 301 12C 12D Status Device identification Status Device name R R UINT8[2] CHAR[*] 302 12E Status Sniffer probe type R UINT8 310 136 Status SW-version main board R UINT8[3] 311 137 Status SW-version probe programming master R UINT8[3] Software version of master, by which this sniffer probe was programmed Index 0: Main version Index 1: Sub version Index 2: always 0 312 138 Status R UINT8[3] Software version pro
Command Class Name dez hex 313 139 Status SW-version I/O module R/W Data type Description R/W UINT8[3] Software version IO module Index 0: Main version Index 1: Sub version Index 2: Debug version write for internal use only Software version control unit Index 0: Main version Index 1: Sub version Index 2: Debug version write for internal use only Software version of boot loader Software version of boot loader IO module write for internal use only CRC-code main board High word: Caclulated value Low word: No
Command Class Name R/W Data type Description dez hex 413 19D Param Sniffer LED alarm configuration R/W UINT8 Configures the behavior of the white sniffer pobe LEDs in case of trigger alarm: 0=disabled (same Brightness as during normal measurement) 1=on (higher brightness as during normal measurement if possible) 2=blink (Default: 2) 414 19E Param Sniffer white LED brightness R/W UINT8 Configures the brightness of the white sniffer pobe LEDs in case of normal measurement: 0=off ...
Command Class Name dez hex 438 1B6 Param PLC input configuration IO module 440 1B8 450 R/W Data type Description R/W UINT8[10] Meas 1C2 Remaining life time COOLCheck [d] Param Date+Time [YMDhms] R/W UINT8[6] 459 460 480 485 1CB 1CC 1E0 1E5 Param Param Param Param R/W R/W R/W R/W 486 1E6 Param Gas type (smart probe only) R/W UINT8 489 490 1E9 1EA Param ID of last calibrated probe Param Probe ID R R Phase Calibration factor instrument Auto standby interval [min] User gas factors UINT16
Command Class Name dez hex 600 258 Param Audio alarm type R/W Data type Description R/W UINT8 1161 489 Control Parameter reset W UINT8 1581 62D Meas Acceleration R SINT16[3] 1631 65F Meas Light barrier voltages [V] R FLOAT[2] 1800 708 Status Active protocol IO R UINT8 1815 717 2593 A21 Status Reset source Param Interface protocol IO R UINT8 R/W UINT8 2659 A63 Param Sniffer tip filter change request R/W UINT8 28 LD Protocol Audio alarm type 0 = Alarm off 1 = Trigger alarm 2 = Setpo
3.5 Error Messages Telegram error handling • Slave discards all characters until it receives a ENQ as telegram start identifier. • Slave does not generate an error message, if address is not correct. • Slave reports CRC errors with error message 1 (CRC failure) • Slave reports length errors with error message 2 (Illegal telegram length) or 11 (Data length is not correct for the command) To prevent the response from colliding with the next request, the slaves do not respond in case of a timeout.
4 Fieldbus Communication 4.1 Preface In order to use fieldbus communication with HLD6000, you need an INFICON BusModule BM1000 connected to the I/O port of the HLD6000. Fieldbus systems normally support device-specific configuration files e.g. GSD files for the PROFIBUS field bus system. You will find the appropriate configuration files on the USB memory stick which is supplied with your HLD6000. For example IFCN0E8D.GSD file for PROFIBUS. 4.
Process Data Mapping for Cyclic Data Transfer 4.3.1 Read Process Data (PLC Leak Detector) Fieldbus Communication This data word (2 Bytes) is send periodically from the field bus master (e.g. programmable logic controller) to the leak detector: PROFIBUS and PROFINET IO receive high byte first, DeviceNet and EtherNet/IP receive low byte first. Title Byte control word 31 4.
4.3.2 Write Process Data (Leak Detector PLC) These 29 data bytes are send periodically from the leak detector to the field bus master (e.g. a programmable logic controller): Attention: PROFIBUS and PROFINET IO sends high byte first, DeviceNet and EtherNet/IP sends low byte first. Byte 2 (high byte) Similar to RS232 ASCII cmd.
Meaning Similar to IO1000 Output Similar to RS232 ASCII cmd. Similar to RS232 LD cmd. 3...6 Leak rate (g/a) Actual leak rate in g/a (IEEE 754 float value) Analog output *READ:g/a? 129 7...10 not used 11...12 Actual error number Error/warning code (16 bit unsigned integer) Error *STATUS:ERROR? 290 0 Status of Setpoint 1 Trigger 1 *STATUS:TRIGger? 387 1 Status of Setpoint 2 0 = Leak rate lower than setpoint 1 = Leak rate higher than setpoint 2 ...
Fieldbus Communication Byte device specific word device specific float 3 device specific float 2 34 Title Bit Name Meaning 20...23 device specific float 2 Differential pressure p2 in arbitrary unit (IEEE 754 float value) 24...27 not used reserved for further use, always 0 28...29 not used reserved for further use, always 0 Similar to IO1000 Output Similar to RS232 ASCII cmd. Similar to RS232 LD cmd.
4.4 Acyclic Data Transfer If you want to use acyclic data transfer with PROFIBUS, you must use a PROFIBUS master which supports DPV1 data transfers. A PROFIBUS master which supports DPV0 only, can only use cyclic data transfer. 4.4.
4.5 Hardware Configuration for PROFIBUS Sequence of the data words (slots) must be: • Output at first, inputs at second. • One or two words are accessible at once. • Output and inputs must have the same memory start address. Example hardware configuration (detail from PLC configuration window) 4.5.1 Assignment of the PROFIBUS Address The PROFIBUS address can be assigned via HLD6000 display or via the hardware configuration tool of the PLC.
5 Trouble Shooting 5.1 Serial Communication via RS232 (common) Error No characters are received via the interface/the leak detector does not answer Solution Please use a 1:1 cable, (NO null-modem cable, also called cross-over cable!) Problems with flow control Deactivate flow control in PC/PLC or use cable according to the wiring diagram in chapter 4 of the IO1000 documentation.
5.3 LD Protocol specific Error IO1000 does not reply Possible Reason Wrong Address Other protocol errors IO1000 replys with CRC error (error code 1) Wrong CRC calculation 38 Trouble Shooting Solution Always use Address 1 in LD protocol. Try to use NOP command (05hex 04hex 01hex 00hex 00hex 77hex) first, to check if connection works in general. The answer should be 02hex 05hex XXhex XXhex 00hex 00hex XXhex Check you CRC code calculation. See example C source file "CRC_calculation.
Trouble Shooting 39
INFICON GmbH, Bonner Strasse 498, D-50968 Cologne, Germany UNITED STATES TAIWAN JAPAN KOREA SINGAPORE GERMANY FRANCE UNITED KINGDOM HONG KONG Vi sit o ur we bsi t e fo r con t act i nfo rm ati on an d o t her sal es o ffice s wo rl dw id e. w w w . i n f i c o n .
