General Monitors IR4000M Installation manual

Model IR4000M
Multi-Point Monitor
Modbus programming guide
The information and technical data disclosed in
this document may be used and disseminated
only for the purposes and to the extent
specifically authorized in writing by General
Monitors.
Instruction Manual Modbus 07-08
General Monitors reserves the right to change
published specifications and designs without
prior notice.
MANIR4000MM
Part No. MANIR4000M Modbus
Revision A/07-08

Model IR4000M
ii
This page intentionally left blank.

Model IR4000M
iii
Table of Contents
MODEL IR4000M ..........................................................................................................................I
MULTI-POINT MONITOR..............................................................................................................I
MODBUS PROGRAMMING GUIDE .............................................................................................I
1.MODBUS RTU........................................................................................................................5
1.1Serial Communications Protocol for IR4000M..........................................................5
1.1.1Baud Rate.................................................................................................................5
1.1.2Data Format..............................................................................................................5
1.1.3Modbus Read Status Protocol (Query/Response)....................................................5
1.1.4Modbus Write Command Protocol (Query/Response) .............................................6
1.1.5Modbus Write Response Message...........................................................................6
1.2Function Codes Supported.......................................................................................7
1.2.1Exception Responses and Exception Codes............................................................7
1.3IR4000 Modbus Registers Summary Table..............................................................9
1.4IR4000 Modbus Base Registers Details.................................................................17
1.4.1Analog (0000h, Read-Only)....................................................................................17
1.4.2Operating Mode (0001h, Read)..............................................................................17
1.4.3Status Error (0002h, Read-Only)............................................................................18
1.4.4Model Type (0004h, Read-Only).............................................................................19
1.4.5Software Revision (0005h, Read-Only)..................................................................19
1.4.6Display LED Digits Two and Three (0006, Read-Only)..........................................19
1.4.7Display LED Digit One and Alarm/Warning LEDs (0007, Read-Only)..................19
1.4.8Number of Detectors Online (0009h, Read/Write)..................................................20
1.4.9Number of Votes (000Ah, Read/Write)...................................................................20
1.4.10Alarm Relay Settings (000Dh, Read/Write)............................................................20
1.4.11Warning Relay Settings (000Eh, Read/Write) ........................................................20
1.4.12Set CH1 Address (000Fh, Read/Write) ..................................................................21
1.4.13Baud Rate for CH1 (0010h, Read/Write)................................................................21
1.4.14Data Format for CH1 (0011h, Read/Write).............................................................21
1.4.15Modbus Address for CH2 (0012h, Read/Write)......................................................22
1.4.16Baud Rate for CH2 (0013h, Read/Write)................................................................22
1.4.17Data Format for CH2 (0014h, Read/Write).............................................................22
1.4.18Reset Alarm (0016h, Read/Write)...........................................................................22
1.4.19Total Receive Errors for CH1 (0017h, Read-Only).................................................23
1.4.20Function Code Errors for CH1 (0018h, Read-Only)...............................................23
1.4.21Starting Register Address Errors Errors for CH1 (0019h, Read-Only)...................23
1.4.22NVM Faults (001Ah, Read/Wrire)..........................................................................23
1.4.23CRC Hi Errors for CH1 (001Bh, Read-Only) ..........................................................24
1.4.24CRC Low Errors for CH1 (001Ch, Read-Only).......................................................24
1.4.25Overrun Errors for CH1 (001Dh, Read-Only) .........................................................24
1.4.26Framing Errors for CH1 (001Eh, Read-Only) .........................................................24
1.4.27Parity Errors for CH1 (001Fh, Read-Only)..............................................................24
1.4.28Total Receive Errors for CH2 (0021h, Read-Only).................................................24
1.4.29Function Code Errors for CH2 (0022h, Read-Only)...............................................24

Model IR4000M
iv
1.4.30Starting Register Address Errors Errors for CH2 (0023h, Read-Only)...................24
1.4.31CRC Hi Errors for CH2 (0025h, Read-Only)...........................................................25
1.4.32CRC Low Errors for CH2 (0026h, Read-Only)........................................................25
1.4.33Overrun Errors for CH2 (0027h, Read-Only)..........................................................25
1.4.34Framing Errors for CH2 (0028h, Read-Only)..........................................................25
1.4.35Parity Errors for CH2 (0029h, Read-Only)..............................................................25
1.4.36Clear Comm Errors for CH1 (002Ch, Read/Write) .................................................25
1.4.37Clear Comm Errors for CH2 (002Dh, Read/Write) .................................................25
1.4.38Enable HART or Modbus for CH2 (002Dh, Read/Write) ........................................25
1.5IR4000 Modbus Registers for IR400 Data..............................................................25
1.5.1Detector Analog Output (Read-Only)......................................................................25
1.5.2Operating Mode (Read-Only)..................................................................................26
1.5.3Status Error (Read-Only)........................................................................................27
1.5.4Gas Selection (Read-Only).....................................................................................28
1.5.5Model Type ( Read-Only)........................................................................................28
1.5.6Display ( Read-Only)...............................................................................................28
1.5.7Cal IO type (Read-Only) .........................................................................................28
1.5.8Solenoid State (Read-Only)....................................................................................28

Model IR4000M
5
1. MODBUS RTU
1.1 Serial Communications Protocol for IR4000M
The default Modbus setup from the factory is 19200 baud, 8-n-1 format. The default Modbus ID
for CH1 is 1, and for CH2 it is 2.These settings can be changed through the user interface
using the GMI magnet and selecting the SE menu item. Details can be found in the separate
Model IR4000M user manual; section 4.
The factory default settings for Modbus can be restored by connecting the RELAY RESET
terminal (TB2-7) to the power supply common and turning on power to the IR4000M. After 10
seconds, remove the connection between RELAY RESET and common.
1.1.1 Baud Rate
The Baud Rate is a selectable setting via the Modbus Communications Interface. The
selectable baud rates are 9600, 4800, or 2400 bits per second.
1.1.2 Data Format
The Data Format is a selectable setting via the Modbus Communications Interface. The
selectable data formats are as follows:
Data Bits Parity Stop Bit Format
8 None 1 8-N-1
8 Even 1 8-E-1
8 Odd 1 8-O-1
8 None 2 8-N-2
Table 1: Data Format
1.1.3 Modbus Read Status Protocol (Query/Response)
1.1.3.1 Modbus Read Query Message
Byte Modbus Range Referenced to IR400
1st Slave Address 1-247* (Dec) IR400 ID (Address)
2nd Function Code 03 Read Holding Registers
3rd Starting Address Hi** 00 Not Used by IR400
4th Starting Address Lo** 00-FF (Hex) IR400 Commands
5th No. of Registers Hi 00 Not Used by IR400
6th No. of Registers Lo 01 No. of 16 Bit Registers
7th CRC Hi 00-FF (Hex) CRC Hi Byte
8th CRC Lo 00-FF (Hex) CRC Lo Byte
Table 2: Modbus Read Query Message
*NOTE: Address 0 is reserved for broadcast mode and will not be supported at this time.
**NOTE: Start Address can be a maximum of 9999 Address Locations (0000-270E)

Model IR4000M
6
1.1.3.2 Modbus Read Response Message
Byte Modbus Range Referenced to IR400
1st Slave Address 1-247* (Dec) IR400 ID (Address)
2nd Function Code 03 Read Holding Registers
3rd Byte Count 02 No. of Data Bytes
4th Data Hi 00-FF (Hex) IR400 Hi Byte Status Data
5th Data Lo 00-FF (Hex) IR400 Lo Byte Status Data
6th CRC Hi 00-FF (Hex) CRC Hi Byte
7th CRC Lo 00-FF (Hex) CRC Lo Byte
Table 3: Modbus Read Response Message
1.1.4 Modbus Write Command Protocol (Query/Response)
1.1.4.1 Modbus Write Query Message
Byte Modbus Range Referenced to IR400
1st Slave Address 1-247* (Dec) IR400 ID (Address)
2nd Function Code 06 Preset Single Register
3rd Register Address Hi 00 Not Used by IR400
4th Register Address Lo 00-FF (Hex) IR400 Commands
5th Preset Data Hi 00-FF (Hex) IR400 Hi Byte Command Data
6th Preset Data Lo 00-FF (Hex) IR400 Lo Byte Command Data
7th CRC Hi 00-FF (Hex) CRC Hi Byte
8th CRC Lo 00-FF (Hex) CRC Lo Byte
Table 4: Modbus Write Query Message
*NOTE: Address 0 is reserved for broadcast mode and will not be supported at this time.
**NOTE: Start Address can be a maximum of 9999 Address Locations (0000-270E)
1.1.5 Modbus Write Response Message
Byte Modbus Range Referenced to IR400
1st Slave Address 1-247* (Dec) IR400 ID (Address)
2nd Function Code 06 Preset Single Register
3rd Register Address Hi 00 Not Used by IR400
4th Register Address Lo 00-FF (Hex) IR400 Commands
5th Preset Data Hi 00-FF (Hex) IR400 Hi Byte Command Data
6th Preset Data Lo 00-FF (Hex) IR400 Lo Byte Command Data
7th CRC Hi 00-FF (Hex) CRC Hi Byte
8th CRC Lo 00-FF (Hex) CRC Lo Byte
Table 5: Modbus Write Response Message

Model IR4000M
7
1.2 Function Codes Supported
Function Code 03 (Read Holding Registers) will be used to read status from the slave unit.
Function Code 06 (Preset Single Register) will be used to write a command to the slave unit.
1.2.1 Exception Responses and Exception Codes
1.2.1.1 Exception Response
In a normal communications query and response, the master device sends a query to the
IR400 and the IR400 receives the query without a communications error and handles the query
normally within the master device’s allowable timeout. The IR400 then returns a normal
response to the master. An abnormal communications produces one of four possible events:
1. If the IR400 does not receive the query due to a communications error, then no
response is returned from the IR400 and the master device will eventually process a
timeout condition for the query.
2. If the IR400 receives the query, but detects a communication error (CRC, etc.), then no
response is returned from the IR400 and the master device will eventually process a
timeout condition for the query.
3. If the IR400 receives the query without a communications error, but cannot process the
response to the master within the master’s timeout setting, then no response is
returned from the IR400 and the master device will eventually process a timeout
condition for the query. In order to prevent this condition from occurring the maximum
response time for the IR400 is 200 milliseconds. Therefore the MASTER’S Timeout
Setting should be set to 200 milliseconds or greater.
4. If the IR400 receives the query without a communications error, but cannot process it
due to reading or writing to a non-existent IR400 command register, then the IR400 will
return an exception response message informing the master of the error.
The exception response message (ref. No. 4 above) has two fields that differentiate it from a
normal response:
Byte Modbus Range Referenced to IR400
1st Slave Address 1-247* (Dec) IR400 ID (Address)
2nd Function Code 83 or 86 (Hex) MSB is set with Function Code
3rd Exception Code 01 - 06 (Hex) Appropriate Exception Code (See Below)
4th CRC Hi 00-FF (Hex) CRC Hi Byte
5th CRC Lo 00-FF (Hex) CRC Lo Byte
Table 6: IR400 Exception Response Message

Model IR4000M
8
1.2.1.2 Exception Code
Exception Code Field: In a normal response, the IR400 returns data and status in the data
field, which was requested in the query from the master. In an exception response, the IR400
returns an exception code in the data field, which describes the IR400 condition that caused the
exception. Below is a list of exception codes that are supported by the IR400:
Code Name Description
01 Illegal Function The function code received in the query is not an allowable
action for the IR4000.
02 Illegal Data Address The data address received in the query is not an allowable
address for the IR4000.
03 Illegal Data Value A value contained in the query data field is not an allowable
value for the IR4000.
04 Slave Device Failure An unrecoverable error occurred while the IR4000 was
attempting to perform the requested action.
05 Acknowledge The IR4000 has accepted the request and is processing it,
but a long duration of time will be required to do so. This
response is returned to prevent a timeout error from
occurring in the master.
06 Device Busy The IR4000 is engaged in processing a long-duration
program command. The master should retransmit the
message later when the slave is free.
Table 7: IR4000 Exception Codes

Model IR4000M
9
1.3 IR4000 Modbus Registers Summary Table
Register
Address
(Hex) Parameter Function Data
Type Data Range Access
0000H Analog Output 0-20mA current
output Numeric Value 0-65535 Dec, (scale to range
0-21.7mA) R
0001h Operating Mode Set/View operating
mode Bit Map See register description R/W
0002h Error Status View present error Bit Map See register
description R
0003h Misc. Fault For GMI use N/A N/A R
0004H Model Number View Model ID Numeric
Value 4002, etc. R
0005h Software Rev Software Revision 2 ASCII
characters A, B, etc. R
0006h Display digits 2
and 3 Shows present 2nd
and 3rd display digits
on IR4000 front
panel.
2 ASCII
characters Hi byte – 2nd
digit,
Lo byte – 3rd digit R
0007h Display LED digit
1 and Alarm /
Warning LEDs
Shows present front
panel display digit 1,
and Alarm / Warning
lights
1 ASCII
character
and LEDs
status
Hi byte – 1st
digit,
Lo byte : bit map
bit 3 – low LED
bit 4 - hi LED
R
0008h Line voltage Measured line voltage
* 10 Numeric Value 0-65535 R
0009h No. of Units
Online Defines no. of IR400
units connected Numeric Value 1-8 R/W
000Ah No. of Votes Determines how
many detectors must
reach alarm setpoint
to trigger
alarm/warning
Numeric
Value 1-8
R/W
000Bh Priority Fault Read main fault of the
IR4000 device Bit Map See register 0x0002
description R
000Ch HART
configuration Hi byte – AO range;
Lo byte – HART
enabled/disabled
Hi byte –
AO range;
Lo byte –
HART
enabled/di
sabled
Hi byte: 0 – hi
range,
1 – lo range,
Low byte: 0 –
disabled, 1 –
HART enabled
R/W
000Dh Alarm Relay
settings Read or change
settings for alarm Bit Map See description R/W

Model IR4000M
10
Register
Address
(Hex) Parameter Function Data
Type Data Range Access
000Eh Warning Relay
settings Read or change
settings for warning Bit Map See description R/W
000Fh Address for CH1 Set/View CH1
address Numeric Value 1-247 decimal R/W
0010h Baud Rate for
CH1 Set/View CH1 Baud
Rate (2400, 4800,
9600 19200)
Code 0, 1, 2, 3 R/W
0011h Data Format for
CH1 Set/View CH1 Data
Format (8N1, 8E1,
801, 8N2)
Code 0, 1, 2, 3 R/W
0012h Address for CH2 Set/View CH2
address Numeric Value 1-247 decimal R/W
0013h Baud Rate for
CH2 Set/View CH2 Baud
Rate (2400, 4800,
9600 19200)
Code 0, 1, 2, 3 R/W
0014h Data Format for
CH2 Set/View CH2 Data
Format (8N1, 8E1,
801, 8N2)
Code 0, 1, 2, 3 R/W
0015h Reserved N/A N/A N/A N/A
0016h Reset Alarm Resets latching
alarms Numeric Value 0 W
0017h Receive errors for
CH1 Number of CH1 total
receive errors Numeric Value 0-65535 decimal R
0018h Function code
errors for CH1 Number of CH1
function code errors. Numeric Value 0-65535 decimal R
0019h Starting Register
Address errors for
CH1
Number of CH1
Starting Register
Address errors.
Numeric
Value 0-65535 decimal R
001Ah NVM region Faults View/Reset NVM
pages fault Bit map See register
description R/W
001Bh CRC errors HI for
CH1 Number of CH1 CRC
HI errors Numeric Value 0-65535 decimal R
001Ch CRC errors LO for
CH1 Number of CH1 CRC
LO errors Numeric Value 0-65535 decimal R
001Dh Overrun errors
for CH1 Number of Overrun
errors for CH1 Numeric
Value 0-65535 decimal R
001Eh Framing errors for
CH1 Number of framing
errors for CH1 Numeric
Value 0-65535 decimal R
001Fh Parity errors for
CH1 Number of Parity
errors for CH1 Numeric
Value 0-65535 decimal R
0020h Reserved N/A N/A N/A R
0021h Receive errors for
CH2 Number of CH2 total
receive errors Numeric Value 0-65535 decimal R
0022h Function code
errors for CH2 Number of CH2
function code errors. Numeric Value 0-65535 decimal R