IL 17384 – Part F Transfer Switches and I/O Devices
June 2004 Revision 3.20
A reference guide for programming INCOM system communications – including the INCOM RS-232 and INCOM/UDP protocols.
IL 17384 – Part F Transfer Switches and I/O Devices
June 2004
Revision 3.20
A reference guide for programming INCOM system communications – including the INCOM RS-232 and INCOM/UDP protocols.
Limits of Liability and Disclaimer of Warranty The authors and publisher of this manual have used their best efforts in preparing this user manual and the programs contained in it. These efforts include the development, research, and testing of the theories and programs to determine their effectiveness. The authors and publisher make no warranty of any kind, expressed or implied, with regard to these programs or documentation contained in this book. The authors and publisher shall not be liable in any event for incidental or consequential damages in connection with, or arising out of, the furnishing, performance, or use of these programs or this user manual. If further information is desired by purchaser regarding the installation, operation, or maintenance of the software described in this user manual, the local Eaton Electrical representative should be contacted. ALL WARRANTIES OF MERCHANTABILITY AND FITNESS FOR PARTICULAR PURPOSE ARE DISCLAIMED. Trademarks INCOM and IMPACC are trademarks of the Eaton Corporation. Copyright 1991, 1992, 1993, 1994, 1995, 1996, 1998, 2002, 2003, 2004 Eaton Electrical Power Quality Division 150 Industry Drive Pittsburgh, PA 15275 Eaton Corporation INCOM System Communications June 2004
Contents
Part F – Transfer Switches and I/O Devices Section Title Page 501 Communications Protocol for the Addressable Relay 501-1
502 Communications Protocol for the Universal RTD Module 502-1
503 Communications Protocol for the Analog Input Module (AIM) 503-1
504 Communications Protocol for the IQ Transfer II 504-1
505 Communications Protocol for the IQ Transfer 505-1
506 Communications Protocol for the ATC-400 506-1
507 Communications Protocol for the Digital Input Module (DIM) 507-1
INCOM System Communications, June 2004 i
Contents
ii INCOM System Communications, June 2004
This page intentionally left blank.
Communications Protocol for the Addressable Relay
COMMUNICATIONS PROTOCOL – ADDRESSABLE RELAY The Addressable Relay is a stand-alone slave-type INCOM device. It conforms to the communications standards of a stand-alone slave as described in Part A, Section 4.2 of IL 17384.
Supported Commands Refer to Part A, Section 4.2 to find complete descriptions of each of the following 7 commands.
(0,F,F) Energize Relay – Do Not Reply
(1,F,F) De-Energize Relay – Do Not Reply
(5,F,F) Block De-Energize Relay – Up to 16 relays and other stand-alone slaves
(8,F,F) Energize Relay – Send Reply
(9,F,F) De-Energize Relay – Send Reply
(E,F,F) De-Energize Relay – All stand-alone slaves
(F,x,x) Send Status
All commands except for Send Status (F,x,x) must be sent twice.
Refer to Part A, Section 4 for detailed information on the above INCOM Commands.
Note: The status of the Addressable Relay's Input 1 is transmitted in Bit 3 of the SCOMM field (Bit 26 of the 33-bit INCOM message). The status of Input 2 is transmitted in Bit 2 of the SCOMM field (Bit 25 of the 33-bit INCOM message). The value of zero indicates voltage is present on the Addressable Relay input.
INCOM System Communications, June 2004 501-1
Communications Protocol for the Addressable Relay
501-2 INCOM System Communications, June 2004
CHANGE RECORD Revision Date Changes
1.00 6/28/02 Taken from IL 17384 Revision 3.10 (June 2002) Part F; made into separate document for inclusion in Revision 3.20.
Communications Protocol for the Universal RTD Module
COMMUNICATIONS PROTOCOL – UNIVERSAL RTD MODULE
Fast Status (3 0 0) Division Code = 1
Product ID = 19
Comm Version >= 1
Status Bits: Bit Definition
S7-S6 0 0 Failure
0 1 OK
S4 Set if powered on since last Fast Status request
Supported Commands Reference Section (3 0 0) Fast Status Part A, 5.2.3
(3 0 3) Transmit All Standard Buffers Part A, 5.2.8
(3 0 F) Transmit Temperature Buffer Part A, 5.2.17
Temperature Buffer (N=1 –
Expanded Buffer #1)
(3 C 8) Transmit Flags Buffer Part A, 5.2.19, this section
(3 C 9) Transmit Setpoints Buffer Part A, 5.2.20, this section
INCOM System Communications, June 2004 502-1
Communications Protocol for the Universal RTD Module
FLAGS Buffer Description (3 C 8)
Message Byte Name Description
1 Byte0 Number of additional data messages=0
Byte1 Flags1: Bit Definition
B0 RAM failure
B1-B7 Reserved
Byte2 Reserved
502-2 INCOM System Communications, June 2004
Communications Protocol for the Universal RTD Module
SETPOINT Buffer Description (3 C 9)
Message Byte Description 1 Byte0 Number of additional data messages = 1
Byte1 Firmware Revision
Byte2 Firmware Version
2 Byte0 SW1 – Note the ordering of the bits:
Bit Definition
B0 Switch 1
: :
B7 Switch 8
Note: 0 = On
1 = Off
Byte1 Reserved
Byte2 Reserved
Note: Refer to IL 17367 for more information on the Universal RTD Switch settings.
INCOM System Communications, June 2004 502-3
Communications Protocol for the Universal RTD Module
502-4 INCOM System Communications, June 2004
CHANGE RECORD Revision Date Changes
1.00 6/28/02 Taken from IL 17384 Revision 3.10 (June 2002) Part F; made into separate document for inclusion in Revision 3.20.
Communications Protocol for the Analog Input Module
COMMUNICATIONS PROTOCOL – ANALOG INPUT MODULE (AIM)
Fast Status (3 0 0) Division Code =10
Product ID: =1
Comm Version: 0 – Initial product version
Status Bits: Bit Definition S7-S6 0 0 Off
0 1 Normal
1 0 N/A
1 1 Alarm (See Note 1.)
S5 1 = N/A
S4 1 = Powered up since last Fast Status
S3 1 = Unread Snapshot Buffer (3 C E) available (See Note 2.)
S2 1 = Unread Snapshot Buffer (3 C C) available (See Note 3.)
S1 1 = AI Module Internal Communication link is functional.
S0 1 = Output Relay #1 Energized
Note 1: See Flags Buffer (3 C 8) to determine cause of alarm(s).
Note 2: This bit is reset when BTU General Purpose Sensor Snapshot Values Buffer (3 C E) is sent.
Note 3: This bit is reset when Running Total Snapshot Values Buffer (3 C C) is sent.
Supported Commands Reference Section (3 0 0) Fast Status Part A, 5.2.3 and above
(3 A 4) Transmit INCOM Slave-Interface Statistics Part A, 5.2.28.2
(3 A 5) Transmit Product-Specific Statistics Buffer Part A, 5.2.28.3
(3 C 8) Transmit Flags Buffer Part A, 5.2.19, this section
(3 C 9) Transmit Setpoints Buffer Part A, 5.2.20, this section
(3 C C) Transmit Running Total Snapshot Values Buffer This section
(3 C D) Transmit Counters Buffer This section
(3 C E) Transmit BTU General Purpose Sensor
Snapshot Values Buffer This section
INCOM System Communications, June 2004 503-1
Communications Protocol for the Analog Input Module
Supported Commands – Continued Reference Section
(3 C F) Transmit Device Data Buffer Part A, 5.3.6, this section
N=49xx01H
N=49xx02H
N=49xx03H
N=49xx09H
N=4DxxyyH
(3 C F) Transmit Profile Data Buffer Part A, 5.3.6, this section
N=50xx02H Transmit Reserved Sensor Data 1-16
N=502102H Transmit Sensor Configurations
N=50xx03H Transmit Reserved Data 17-32
(3 D 0) Slave Action Part A, 5.2.23.1, 5.3.7, this section
(3 D 8) Receive Current Date and Time Part A, 5.2.25.1
(3 F 9) Download Setpoints Part A, 5.2.26.2, this section.
(D 0 0) Broadcast Snapshot Energy Buffer Part A, 5.2.27, 5.3.1.1, this section
(D E 3) Broadcast Synchronize RTC Part A, 5.2.27
503-2 INCOM System Communications, June 2004
Communications Protocol for the Analog Input Module
FLAGS Buffer Description (3 C 8)
Message Byte Name Description 1 Byte0 Number of additional data messages=4
Byte1 Reserved
Byte2 Reserved
2 Byte0 Status: Bit Definition
B0 Reserved = 0
B1 1=Sensor Profile Error
B2 1=N/A
B3 1=Clock Error
B4 1=Internal Communication Link Error
B5 1=Memory Error
B6 1=Checksum Error
B7 Reserved = 0
Byte1 Number of Sensors Configured
Byte2 Sensors: Bit Definition B0 1= Sensor #1 H/W error
B1 1= Sensor #2 H/W error
.
.
.
B7 1= Sensor #8 H/W error
INCOM System Communications, June 2004 503-3
Communications Protocol for the Analog Input Module
FLAGS Buffer Description (3 C 8) – Continued Message Byte Name Description
3 Byte0 B0 1= Sensor #9 H/W error
B1 1= Sensor #10 H/W error
.
.
.
B7 1= Sensor #16 H/W error
Byte1 B0 1= Sensor #17 H/W error
B1 1= Sensor #18 H/W error
.
.
.
B7 1= Sensor #24 H/W error
Byte2 B0 1= Sensor #25 H/W error
B1 1= Sensor #26 H/W error
.
.
.
B7 1= Sensor #32 H/W error
4 Reserved = 0
5 Byte0 LSB of checksum
Byte1 MSB of checksum
Byte2 Complement of checksum of LSB
503-4 INCOM System Communications, June 2004
Communications Protocol for the Analog Input Module
SETPOINT Buffer Description (3 C 9)
Message Byte Description 1 Byte0 Number of additional data messages=4
Byte1 Reserved = 0
Byte2 Reserved = 0
2 Byte0 Firmware Revision
Byte1 Firmware Version
Byte2 Reserved = 0
3 Byte0 Synch Type (type of demand window synchronization)
Value Definition
0 N/A
1 N/A
2 IMPACC
Byte1 Reserved = 0
Byte2 Reserved = 0
4 Reserved = 0
5 Byte0 LSB of checksum
Byte1 MSB of checksum
Byte2 Complement of LSB of checksum
INCOM System Communications, June 2004 503-5
Communications Protocol for the Analog Input Module
Transmit Running Total Snapshot Values Buffer Description (3 C C)
Message Byte Description 1 Byte0 Number of additional data messages (Variable – See Note 1 below.)
Byte1 Number of Sensors Configured
Byte2 Bit Definition
B0 1 = First time (3 C C) buffer has been polled since the Snapshot values command was received. This bit is reset when (3 C C) is sent.
B1 0 = Values are 32-bit dword format (0 - 999,999,999) Rollover occurs at 999,999,999
1 = N/A
B2-B7 Reserved
2 Byte0 Bit Definition
B0 1= Sensor #1 running total value has been reset to zero.
B1 1= Sensor #2 running total value has been reset to zero.
... See Note 2 below.
B7 1= Sensor #8 running total value has been reset to zero.
Byte1 Bit Definition
B0 1= Sensor #9 running total value has been reset to zero.
B1 1= Sensor #10 running total value has been reset to zero.
...
B7 1= Sensor #16 running total value has been reset to zero.
Byte2 Bit Definition
B0 1= Sensor #17 running total value has been reset to zero.
B1 1= Sensor #18 running total value has been reset to zero.
...
B7 1= Sensor #24 running total value has been reset to zero.
503-6 INCOM System Communications, June 2004
Communications Protocol for the Analog Input Module
Transmit Running Total Snapshot Values Buffer Description (3 C C) – Continued
Message Byte Description
3 Byte0 Bit Definition
B0 1= Sensor #25 running total value has been reset to zero.
B1 1= Sensor #26 running total value has been reset to zero.
...
B7 1= Sensor #32 running total value has been reset to zero.
Byte1 1st Configured Sensor Running Total Snapshot Value – LSB
Byte2 1st Configured Sensor Running Total Snapshot Value (Note 3)
4 Byte0 1st Configured Sensor Running Total Snapshot Value (Note 4)
Byte1 1st Configured Sensor Running Total Snapshot Value – MSB
Byte2 2nd Configured Sensor Running Total Snapshot Value – LSB
5 Byte0 2nd Configured Sensor Running Total Snapshot Value
Byte1 2nd Configured Sensor Running Total Snapshot Value
Byte2 2nd Configured Sensor Running Total Snapshot Value – MSB … i Bytej nth Configured Sensor Running Total Snapshot Value – LSB Bytej+1 nth Configured Sensor Running Total Snapshot Value
Bytej+2 nth Configured Sensor Running Total Snapshot Value
Bytej+3 nth Configured Sensor Running Total Snapshot Value – MSB
INCOM System Communications, June 2004 503-7
Communications Protocol for the Analog Input Module
Transmit Running Total Snapshot Values Buffer Description (3 C C) – Continued
Note 1: The number of additional messages in the Snapshot Values Buffer varies depending upon the sensor configuration at the AIM. The following expression relates the number of sensors configured to the number of additional messages. The number of sensors configured can be determined from any of the following:
- (3 C C) Message 1, Byte1
- (3 C 8) Flags Buffer Message 2, Byte2
- (3 C F) Profile Data Buffers, N = 502101H Sensor Configuration
Number of Additional Messages =
ceil ((1+( 4 * Number of Sensors Configured) )/ 3)+ 1
where ceil (x) is the smallest integer not less than x.
The snapshot running total sensor values are sent only for configured sensors. The values are sent sequentially starting from the lowest configured sensor number to the highest configured sensor number (unconfigured sensors are skipped). The sensor profiles can be used to determine the relationship between the snapshot value and the sensor number.
Note 2: This bit is set when the running total sensor value is reset to zero as a result of a Slave Action command. See (3 D 0) Slave Action command Reset Sensor #x Running Total Value. All bits in Message 2 and Message 3, Byte0, are reset upon Slave Action (3 0 6).
Note 3: A 32-bit sensor snapshot value equal to 80000000H indicates an invalid reading.
Note 4: For BTU sensor types, the BTU calculation uses 3 consecutive sensors i, i+1 and i+2. The (3 C C) command sends BTU snapshot measurements (if any) as follows:
Sensor i measures Forward BTUs, ♦
♦
♦
Sensor i+1 measures Reverse BTUs,
Sensor i+2 measures Net BTUs.
503-8 INCOM System Communications, June 2004
Communications Protocol for the Analog Input Module
Counters Buffer Description (3 C D) Message Byte Description
1 Byte0 Number of additional data messages=11
Byte1 Reserved
Byte2 Reserved
2 Byte0 Sensor #1 Min/Max Change Counter (Rollover to 1 at 255)
Byte1 Sensor #2 Min/Max Change Counter
Byte2 Sensor #3 Min/Max Change Counter
3 Byte0 Sensor #4 Min/Max Change Counter
Byte1 Sensor #5 Min/Max Change Counter
Byte2 Sensor #6 Min/Max Change Counter
4 Byte0 Sensor #7 Min/Max Change Counter
Byte1 Sensor #8 Min/Max Change Counter
Byte2 Sensor #9 Min/Max Change Counter
5 Byte0 Sensor #10 Min/Max Change Counter
Byte1 Sensor #11 Min/Max Change Counter
Byte2 Sensor #12 Min/Max Change Counter
6 Byte0 Sensor #13 Min/Max Change Counter
Byte1 Sensor #14 Min/Max Change Counter
Byte2 Sensor #15 Min/Max Change Counter
7 Byte0 Sensor #16 Min/Max Change Counter
Byte1 Sensor #17 Min/Max Change Counter
Byte2 Sensor #18 Min/Max Change Counter
8 Byte0 Sensor #19 Min/Max Change Counter
Byte1 Sensor #20 Min/Max Change Counter
Byte2 Sensor #21 Min/Max Change Counter
INCOM System Communications, June 2004 503-9
Communications Protocol for the Analog Input Module
Counters Buffer Description (3 C D) – Continued Message Byte Description
9 Byte0 Sensor #22 Min/Max Change Counter
Byte1 Sensor #23 Min/Max Change Counter
Byte2 Sensor #24 Min/Max Change Counter
10 Byte0 Sensor #25 Min/Max Change Counter
Byte1 Sensor #26 Min/Max Change Counter
Byte2 Sensor #27 Min/Max Change Counter
11 Byte0 Sensor #28 Min/Max Change Counter
Byte1 Sensor #29 Min/Max Change Counter
Byte2 Sensor #30 Min/Max Change Counter
12 Byte0 Sensor #31 Min/Max Change Counter
Byte1 Sensor #32 Min/Max Change Counter
Byte2 Reserved = 0
Note 1: If a sensor is configured as a BTU type sensor, the Min/Max Change Counter for that sensor is shared for the for the General Purpose (GP) Sensor Min/Max Measurement data and the BTU Min/Max Measurement data. The counter will be incremented on a new Min/Max value for either the General Purpose (GP) Sensor Min/Max Measurement data or BTU Min/Max Measurement data.
503-10 INCOM System Communications, June 2004
Communications Protocol for the Analog Input Module
Transmit BTU General Purpose Sensor Snapshot Values Buffer (3 C E)
Message Byte Description 1 Byte0 Number of additional data messages = 12
Byte1 Number of BTU Sensors Configured
Byte2 Bit Definition
B0 1 = First time (3 C E) buffer has been polled since the Snapshot values command was received. This bit is reset when (3 C E) is sent.
B1 0 = Values are 32-bit dword format (0-999,999,999) Rollover occurs at 999,999,999
1 = N/A
B2-B7 Reserved
2 Byte0 1st BTU Sensor Flow Snapshot Value – LSB
Byte1 1st BTU Sensor Flow Snapshot Value (See Note 2.)
Byte2 1st BTU Sensor Flow Snapshot Value (See Note 3.)
3 Byte0 1st BTU Sensor Flow Snapshot Value – MSB
Byte1 1st BTU Sensor Low Temperature Snapshot Value – LSB
Byte2 1st BTU Sensor Low Temperature Snapshot Value
4 Byte0 1st BTU Sensor Low Temperature Snapshot Value
Byte1 1st BTU Sensor Low Temperature Snapshot Value – MSB
Byte2 1st BTU Sensor High Temperature Snapshot Value – LSB
5 Byte0 1st BTU Sensor High Temperature Snapshot Value
Byte1 1st BTU Sensor High Temperature Snapshot Value
Byte2 1st BTU Sensor High Temperature Snapshot Value – MSB
INCOM System Communications, June 2004 503-11
Communications Protocol for the Analog Input Module
Transmit BTU General Purpose Sensor Snapshot Values Buffer (3 C E) – Continued
Message Byte Description
6 Byte0 2nd Btu Sensor Flow Snapshot Value – LSB
Byte1 2nd Btu Sensor Flow Snapshot Value
.
.
. 12 Byte0 3rd BTU Sensor Low Temperature Snapshot Value
Byte1 3rd BTU Sensor Low Temperature Snapshot Value – MSB
Byte2 3rd BTU Sensor High Temperature Snapshot Value – LSB
13 Byte0 3rd BTU Sensor High Temperature Snapshot Value
Byte1 3rd BTU Sensor High Temperature Snapshot Value
Byte2 3rd BTU Sensor High Temperature Snapshot Value – MSB
Note 1: If no BTU sensors are configured the device shall respond with a (3 1 5) NACK message.
Note 2: BTU sensors are configured from 3 consecutive sensors:
The first sensor measures the flow, ♦
♦
♦
the second measures the low temperature (temperature in the reverse direction),
the third measures the high temperature (temperature in the forward direction).
Note 3: A 32-bit sensor snapshot value equal to 80000000H indicates an invalid reading. The snapshot values for unconfigured 2nd or 3rd BTU sensors will always be invalid.
503-12 INCOM System Communications, June 2004
Communications Protocol for the Analog Input Module
Device Data Buffer Description (3 C F)
Transmit General Purpose (GP) Sensor Present Measurements (N = 49xx01H) BYTE2 (most significant byte) 7310 = Transmit present sensor measurements
BYTE1 1-3210 = Sensor #
BYTE0 1 = GP Sensor
Message Byte Description 1 Byte0 Number of additional data messages=4
Byte1 Sensor # = xx
Byte2 Sensor Type = 1
2 Byte0 Average Value (1 second) – LSB
Byte1 Average Value (1 second)
Byte2 Average Value (1 second)
3 Byte0 Average Value (1 second) – MSB
Byte1 Average Value (Sliding Window #1) – LSB
Byte2 Average Value (Sliding Window #1)
4 Byte0 Average Value (Sliding Window #1)
Byte1 Average Value (Sliding Window #1) – MSB
Byte2 Average Value (Sliding Window #2) – LSB
5 Byte0 Average Value (Sliding Window #2)
Byte1 Average Value (Sliding Window #2)
Byte2 Average Value (Sliding Window #2) – MSB
INCOM System Communications, June 2004 503-13
Communications Protocol for the Analog Input Module
Device Data Buffer Description (3 C F) – Continued
Transmit General Purpose (GP) Sensor Present Measurements (N = 49xx01H) – Continued
Note 1: If the sensor is not configured as a GP or a BTU sensor the device shall respond with a (3 1 5) NACK message.
Note 2: BTU sensors which are configured from 3 consecutive sensors:
♦ The first sensor measures the flow,
♦ the second measures the low temperature (temperature in the reverse direction),
♦ the third measures the high temperature (temperature in the forward direction).
General Purpose (GP) Sensor Present Measurement data is available for BTU type sensors. If the BTU sensor uses the 3 consecutive sensors xx, xx+1 and xx+2. The (3 C F) N = 49xx01H sends GP measurements as follows:
♦ Sensor xx measures flow,
♦ Sensor xx+1 measures low temperature,
♦ Sensor xx+2 measures high temperature.
Note 3: A 32-bit sensor average value equal to 80000000H indicates an invalid reading.
503-14 INCOM System Communications, June 2004
Communications Protocol for the Analog Input Module
Device Data Buffer Description (3 C F) – Continued
Transmit Pulse Input Sensor Present Measurements (N = 49xx02H) BYTE2 (most significant byte) 7310 = Transmit present sensor measurements
BYTE1 1-3210 = Sensor #
BYTE0 2 = Pulse Input Sensor
Message Byte Description Format 1 Byte0 Number of additional data messages=9
Byte1 Sensor # = xx
Byte2 Sensor Type = 2
2 Byte0 Running total – LSB
Byte1 Running total
Byte2 Running total
3 Byte0 Running total – MSB
Byte1 Total (Sliding Window #1) – LSB
Byte2 Total (Sliding Window #1)
4 Byte0 Total (Sliding Window #1)
Byte1 Total (Sliding Window #1) – MSB
Byte2 Total (Sliding Window #2) – LSB
5 Byte0 Total (Sliding Window #2)
Byte1 Total (Sliding Window #2)
Byte2 Total (Sliding Window #2) – MSB
6 Byte0 Time of reset – 1/100 second (0-99 BCD)
Byte1 Time of reset – Hour (0-23 BCD)
Byte2 Time of reset – Minute (0-59 BCD)
INCOM System Communications, June 2004 503-15
Communications Protocol for the Analog Input Module
Device Data Buffer Description (3 C F) – Continued
Transmit Pulse Input Sensor Present Measurements (N = 49xx02H) – Continued
Message Byte Description Format 7 Byte0 Time of reset – Second (0-59 BCD)
Byte1 Time of reset – Month (1-12 BCD)
Byte2 Time of reset – Day (1-31 BCD)
8 Byte0 Time of reset – Year (0-99 BCD)
Byte1 Time of rollover – 1/100 second (0-99 BCD)
Byte2 Time of rollover – Hour (0-23 BCD)
9 Byte0 Time of rollover – Minute (0-59 BCD)
Byte1 Time of rollover – Second (0-59 BCD)
Byte2 Time of rollover – Month (1-12 BCD)
10 Byte0 Time of rollover – Day (1-31 BCD)
Byte1 Time of rollover – Year (0-99 BCD)
Byte2 Reserved = 0
Note 1: If the sensor is not configured as a Pulsed Input Sensor the device shall respond with a (3 1 5) NACK message.
Note 2: A 32-bit Input Sensor Present Measurements value equal to 80000000H indicates an invalid reading.
503-16 INCOM System Communications, June 2004
Communications Protocol for the Analog Input Module
Device Data Buffer Description (3 C F) – Continued
Transmit Runtime Sensor Present Measurements (N = 49xx03H) BYTE2 (most significant byte) 7310 = Transmit present sensor measurements and status
BYTE1 1-3210 = Sensor #
BYTE0 3 = Runtime Sensor
Message Byte Description Format 1 Byte0 Number of additional data messages=14
Byte1 Sensor # = xx
Byte2 Sensor Type = 3
2 Byte0 Running total – LSB (in seconds)
Byte1 Running total
Byte2 Running total
3 Byte0 Running total – MSB
Byte1 Total OFF to ON Transitions – LSB
Byte2 Total OFF to ON Transitions
4 Byte0 Total OFF to ON Transitions
Byte1 Total OFF to ON Transitions – MSB
Byte2 Runtime (Sliding Window #1) – LSB (in seconds) (See Note 2.)
5 Byte0 Runtime (Sliding Window #1) – MSB
Byte1 OFF to ON Transitions (Sliding Window #2) – LSB (See Note 3.)
Byte2 OFF to ON Transitions (Sliding Window #2) – MSB
6 Byte0 Time of reset – 1/100 second (0-99 BCD)
Byte1 Time of reset – Hour (0-23 BCD)
Byte2 Time of reset – Minute (0-59 BCD)
INCOM System Communications, June 2004 503-17
Communications Protocol for the Analog Input Module
Device Data Buffer Description (3 C F) – Continued
Transmit Runtime Sensor Present Measurements (N = 49xx03H) – Continued
Message Byte Description Format 7 Byte0 Time of reset – Second (0-59 BCD)
Byte1 Time of reset – Month (1-12 BCD)
Byte2 Time of reset – Day (1-31 BCD)
8 Byte0 Time of reset – Year (0-99 BCD)
Byte1 Time of rollover – 1/100 second (0-99 BCD)
Byte2 Time of rollover – Hour (0-23 BCD)
9 Byte0 Time of rollover – Minute (0-59 BCD)
Byte1 Time of rollover –Second (0-59 BCD)
Byte2 Time of rollover – Month (1-12 BCD)
10 Byte0 Time of rollover – Day (1-31 BCD)
Byte1 Time of rollover – Year (0-99 BCD)
Byte2 Time of last OFF to ON transition – 1/100 second (0-99 BCD)
11 Byte0 Time of last OFF to ON transition – Hour (0-23 BCD)
Byte1 Time of last OFF to ON transition – Minute (0-59 BCD)
Byte2 Time of last OFF to ON transition – Second (0-59 BCD)
12 Byte0 Time of last OFF to ON transition – Month (1-12 BCD)
Byte1 Time of last OFF to ON transition – Day (1-31 BCD)
Byte2 Time of last OFF to ON transition – Year (0-99 BCD)
13 Byte0 Time of last ON to OFF transition – 1/100 second (0-99 BCD)
Byte1 Time of last ON to OFF transition – Hour (0-23 BCD)
Byte2 Time of last ON to OFF transition – Minute (0-59 BCD)
14 Byte0 Time of last ON to OFF transition – Second (0-59 BCD)
Byte1 Time of last ON to OFF transition – Month (1-12 BCD)
Byte2 Time of last ON to OFF transition – Day (1-31 BCD)
503-18 INCOM System Communications, June 2004
Communications Protocol for the Analog Input Module
Device Data Buffer Description (3 C F) – Continued
Transmit Runtime Sensor Present Measurements (N = 49xx03H) – Continued
Message Byte Description Format 15 Byte0 Time of last ON to OFF transition – Year (0-99 BCD)
Byte1 Bit Definition
B0 Present status 0 = OFF, 1 = ON
B1-B7 Reserved = 0
Byte2 Reserved
Note 1: If the sensor is not configured as a Runtime sensor, the device responds with a (3 1 5) NACK message.
Note 2: The 16-bit sensor Runtime (Sliding Window #1) value equal to FFFFH indicates an invalid reading.
Note 3: The 16-bit sensor OFF to ON Transitions (Sliding Window #2) value equal to FFFFH indicates an invalid reading.
INCOM System Communications, June 2004 503-19
Communications Protocol for the Analog Input Module
Device Data Buffer Description (3 C F) – Continued
Transmit BTU Sensor Present Measurements (N = 49xx09H)
BYTE2 (most significant byte) 7310 = Transmit present sensor measurements
BYTE1 1-3210 = Sensor # (See Note 1 below.)
BYTE0 9 = BTU Sensor (See Note 2 below.)
Message Byte Description Format 1 Byte0 Number of additional data messages=9
Byte1 Sensor # = xx
Byte2 Sensor Type = 9
2 Byte0 Running total – LSB (See Note 1 below.)
Byte1 Running total
Byte2 Running total
3 Byte0 Running total – MSB
Byte1 Total (Sliding Window #1) – LSB (See Note 3 below.)
Byte2 Total (Sliding Window #1)
4 Byte0 Total (Sliding Window #1)
Byte1 Total (Sliding Window #1) – MSB
Byte2 Total (Sliding Window #2) – LSB (See Note 3 below.)
5 Byte0 Total (Sliding Window #2)
Byte1 Total (Sliding Window #2)
Byte2 Total (Sliding Window #2) – MSB
6 Byte0 Time of reset – 1/100 second (0-99 BCD)
Byte1 Time of reset – Hour (0-23 BCD)
Byte2 Time of reset – Minute (0-59 BCD)
503-20 INCOM System Communications, June 2004
Communications Protocol for the Analog Input Module
Device Data Buffer Description (3 C F) – Continued
Transmit BTU Sensor Present Measurements (N = 49xx09H) – Continued
Message Byte Description Format 7 Byte0 Time of reset – Second (0-59 BCD)
Byte1 Time of reset – Month (1-12 BCD)
Byte2 Time of reset – Day (1-31 BCD)
8 Byte0 Time of reset – Year (0-99 BCD)
Byte1 Time of rollover – 1/100 second (0-99 BCD)
Byte2 Time of rollover – Hour (0-23 BCD)
9 Byte0 Time of rollover – Minute (0-59 BCD)
Byte1 Time of rollover – Second (0-59 BCD)
Byte2 Time of rollover – Month (1-12 BCD)
10 Byte0 Time of rollover – Day (1-31 BCD)
Byte1 Time of rollover – Year (0-99 BCD)
Byte2 Reserved = 0
Note 1: The BTU calculation uses 3 consecutive sensors xx, xx+1 and xx+2. The (3 C F) N = 49xx09H sends BTU measurements as follows:
Sensor xx measures Forward BTUs ♦
♦
♦
Sensor xx+1 measures Reverse BTUs
Sensor xx+2 measures Net BTUs
Note 2: If the sensor is not configured as a BTU sensor, the device responds with a (3 1 5) NACK message.
Note 3: A 32-bit sensor average value equal to 80000000H indicates an invalid reading.
INCOM System Communications, June 2004 503-21
Communications Protocol for the Analog Input Module
Device Data Buffer Description (3 C F) – Continued
Transmit Sensor Min/Max Measurements (N = 4DxxyyH)
BYTE2 (most significant byte) 7710 = Transmit Minimum/Maximum sensor measurements
BYTE1 1-3210 = Sensor #
BYTE0 See Note1, Note2 below Sensor Type 1 = General purpose 2 = Pulse Input
3 = Runtime 9 = BTU
Message Byte Description Format 1 Byte0 Number of additional data messages=17
Byte1 Sensor # = xx
Byte2 Sensor Type
2 Byte0 Sliding Window #1 Minimum Value – LSB (See Note 3 below.)
Byte1 Sliding Window #1 Minimum Value
Byte2 Sliding Window #1 Minimum Value
3 Byte0 Sliding Window #1 Minimum Value – MSB
Byte1 Sliding Window #1 Maximum Value – LSB
Byte2 Sliding Window #1 Maximum Value
4 Byte0 Sliding Window #1 Maximum Value
Byte1 Sliding Window #1 Maximum Value – MSB
Byte2 Sliding Window #2 Minimum Value – LSB
5 Byte0 Sliding Window #2 Minimum Value
Byte1 Sliding Window #2 Minimum Value
Byte2 Sliding Window #2 Minimum Value – MSB
6 Byte0 Sliding Window #2 Maximum Value – LSB
Byte1 Sliding Window #2 Maximum Value
Byte2 Sliding Window #2 Maximum Value
503-22 INCOM System Communications, June 2004
Communications Protocol for the Analog Input Module
Device Data Buffer Description (3 C F) – Continued
Transmit Sensor Min/Max Measurements (N = 4DxxyyH) – Continued
Message Byte Name Description Format 7 Byte0 Sliding Window #2 Maximum Value – MSB
Byte1 Time of reset – 1/100 second (0-99 BCD)
Byte2 Time of reset – Hour (0-23 BCD)
8 Byte0 Time of reset – Minute (0-59 BCD)
Byte1 Time of reset – Second (0-59 BCD)
Byte2 Time of reset – Month (1-12 BCD)
9 Byte0 Time of reset – Day (1-31 BCD)
Byte1 Time of reset – Year (0-99 BCD)
Byte2 Time of Sliding Window #1 Minimum – 1/100 sec(0-99 BCD)
10 Byte0 Time of Sliding Window #1 Minimum – Hour (0-23 BCD)
Byte1 Time of Sliding Window #1 Minimum – Minute (0-59 BCD)
Byte2 Time of Sliding Window #1 Minimum – Second (0-59 BCD)
11 Byte0 Time of Sliding Window #1 Minimum – Month (1-12 BCD)
Byte1 Time of Sliding Window #1 Minimum – Day (1-31 BCD)
Byte2 Time of Sliding Window #1 Minimum – Year (0-99 BCD)
12 Byte0 Time of Sliding Window #1 Maximum – 1/100 sec(0-99 BCD)
Byte1 Time of Sliding Window #1 Maximum – Hour (0-23 BCD)
Byte2 Time of Sliding Window #1 Maximum – Minute (0-59 BCD)
13 Byte0 Time of Sliding Window #1 Maximum – Second (0-59 BCD)
Byte1 Time of Sliding Window #1 Maximum – Month (1-12 BCD)
Byte2 Time of Sliding Window #1 Maximum – Day (1-31 BCD)
14 Byte0 Time of Sliding Window #1 Maximum – Year (0-99 BCD)
Byte1 Time of Sliding Window #2 Minimum –1/100 sec (0-99 BCD)
Byte2 Time of Sliding Window #2 Minimum – Hour (0-23 BCD)
INCOM System Communications, June 2004 503-23
Communications Protocol for the Analog Input Module
Device Data Buffer Description (3 C F) – Continued
Transmit Sensor Min/Max Measurements (N = 4DxxyyH) – Continued
Message Byte Name Description Format 15 Byte0 Time of Sliding Window #2 Minimum – Minute (0-59 BCD)
Byte1 Time of Sliding Window #2 Minimum – Second (0-59 BCD)
Byte2 Time of Sliding Window #2 Minimum – Month (1-12 BCD)
16 Byte0 Time of Sliding Window #2 Minimum – Day (1-31 BCD)
Byte1 Time of Sliding Window #2 Minimum – Year (0-99 BCD)
Byte2 Time of Sliding Window #2 Maximum – 1/100 sec (0-99 BCD)
17 Byte0 Time of Sliding Window #2 Maximum – Hour (0-23 BCD)
Byte1 Time of Sliding Window #2 Maximum – Minute (0-59 BCD)
Byte2 Time of Sliding Window #2 Maximum – Second (0-59 BCD)
18 Byte0 Time of Sliding Window #2 Maximum – Month (1-12 BCD)
Byte1 Time of Sliding Window #2 Maximum – Day (1-31 BCD)
Byte2 Time of Sliding Window #2 Maximum – Year (0-99 BCD)
Note 1: The BTU calculation uses 3 consecutive sensors xx, xx+1 and xx+2. The (3 C F) N = 4Dxx09H sends BTU measurements as follows:
Sensor xx measures Forward BTUs ♦
♦
♦
♦
♦
♦
♦
♦
♦
Sensor xx+1 measures Reverse BTUs
Sensor xx+2 measures Net BTUs
Note 2: BTU sensors are configured from 3 consecutive sensors:
The first sensor measures the flow,
the second measures the low temperature (temperature in the reverse direction),
the third measures the high temperature (temperature in the forward direction).
General Purpose (GP) Sensor Min/Max Measurement data is available for BTU type sensors. If the BTU sensor uses the 3 consecutive sensors xx, xx+1 and xx+2. The (3 C F) N = 4Dxx01H sends GP measurements as follows:
Sensor xx measures flow
Sensor xx+1 measures low temperature
Sensor xx+2 measures high temperature Note 3: A 32-bit sensor Min/Max value equal to 80000000H indicates an invalid reading.
503-24 INCOM System Communications, June 2004
Communications Protocol for the Analog Input Module
Profile Data Buffer Description (3 C F)
Transmit Reserved Sensor Data (N = 50xx02H)
BYTE2 (most significant byte) 8010 = Transmit profile information
BYTE1 1 = Block #1 (Sensors 1-2) 2 = Block #2 (Sensors 3-4)
3 = Block #3 (Sensors 5-6) 4 = Block #4 (Sensors 7-8)
5 = Block #5 (Sensors 9-10) 6 = Block #6 (Sensors 11-12)
7 = Block #7 (Sensors 13-14) 8 = Block #8 (Sensors 15-16)
9 = Block #9 (Sensors 17-18) 10= Block #10 (Sensors 19-20)
11 =Block #11 (Sensors 21-22) 12= Block #12 (Sensors 23-24)
13 =Block #13 (Sensors 25-26) 14= Block #14 (Sensors 27-28)
15 =Block #15 (Sensors 29-30) 16= Block #16 (Sensors 31-32)
BYTE0 2 = Reserved
Message Byte Description 1 Byte0 Number of additional data messages=42
Byte1 Block # xx
Byte2 Reserved = 0
2 Reserved
3 Reserved
4 Reserved
5 Reserved
.
.
.
42 Reserved
43 Byte0 LSB of checksum
Byte1 MSB of checksum
Byte2 Complement of LSB of checksum
INCOM System Communications, June 2004 503-25
Communications Protocol for the Analog Input Module
Profile Data Buffer Description (3 C F) – Continued
Transmit Reserved Data (N = 50xx03H)
BYTE2 (most significant byte) 8010 = Transmit profile information
BYTE1 17 = Block #17 18 = Block #18
19 = Block #19 20 = Block #20
21 = Block #21 22 = Block #22
23 = Block #23 24 = Block #24
25 = Block #25 26 = Block #26
27 = Block #27 28 = Block #28
29 = Block #29 30 = Block #30
31 = Block #31 32 = Block #32
BYTE0 3 = Reserved
Message Byte Description 1 Byte0 Number of additional data messages=42
Byte1 Block # xx
Byte2 Reserved = 0
2 Reserved
3 Reserved
4 Reserved
5 Reserved
.
.
.
42 Reserved
43 Byte0 LSB of checksum
Byte1 MSB of checksum
Byte2 Complement of LSB of checksum
503-26 INCOM System Communications, June 2004
Communications Protocol for the Analog Input Module
Profile Data Buffer Description (3 C F)
Transmit Sensor Configuration (N = 502102H)
BYTE2 (most significant byte) 8010 = Transmit profile information
BYTE1 3310 = Block #33 (Sensors 1-32)
BYTE0 2 = Sensor Configuration
Message Byte Description 1 Byte0 Number of additional data messages=44
Byte1 Reserved = 33
Byte2 Reserved = 0
2 Byte0 Bit Definition
B0-B3 Sensor #1 Type
0 = No sensor
1 = General Purpose
2 = Pulse Contact
3 = Runtime
4 = N/A
5 = N/A
6 = N/A
7 = N/A
8 = N/A
9 = BTU (Maximum of 9 BTU sensors)
B4-B5 Reserved = 0
B6 Sensor #1 Input Range 0 = 0 to 20 mA sensor
1 = 4 to 20 mA sensor
B7 Sensor #1 Phase Direction 0=Normally Open
(Type 3 Runtime sensors only) (Off when Open)
1=Normally Closed (Off when Closed)
Byte1 Sensor #1Threshold (See Notes 1 and 2 below.)
Byte2 Sensor #1 Demand Window #1 [0, 1,…, 30] Minutes (0 = OFF)
INCOM System Communications, June 2004 503-27
Communications Protocol for the Analog Input Module
Profile Data Buffer Description (3 C F) – Continued
Transmit Sensor Configuration (N = 502102H) – Continued Message Byte Description
3 Byte0 Sensor #1 Demand Window #2 [0, 1,…, 15] Minutes (0 = OFF)
Byte1 Bit Definition
B0-B3 Sensor #2 Type
B4-B5 Reserved = 0
B6 Sensor #2 Input Range
B7 Sensor #2 Phase Direction
Byte2 Sensor #2 Threshold
4 Byte0 Sensor #2 Demand Window #1
Byte1 Sensor #2 Demand Window #2
Byte2 Bit Definition
B0-B3 Sensor #3 Type
B4-B5 Reserved = 0
B6 Sensor #3 Input Range
B7 Sensor #3 Phase Direction
5 Byte0 Sensor #3 Threshold
Byte1 Sensor #3 Demand Window #1
Byte2 Sensor #3 Demand Window #2 .
.
.
43 Byte1 Bit Definition
B0-B3 Sensor #32 Type
B4-B5 Reserved = 0
B6 Sensor #32 Input Range
B7 Sensor #32 Phase Direction
Byte2 Sensor #32 Threshold
503-28 INCOM System Communications, June 2004
Communications Protocol for the Analog Input Module
Profile Data Buffer Description (3 C F) – Continued
Transmit Sensor Configuration (N = 502102H) – Continued Message Byte Description
44 Byte0 Sensor #32 Demand Window #1
Byte1 Sensor #32 Demand Window #2
Byte2 Reserved = 0
45 Byte0 LSB of checksum
Byte1 MSB of checksum
Byte2 Complement of LSB of checksum
Note 1: The Threshold setpoint for Pulse Contact and Runtime sensors is in mA times 10(e.g. 18.5 mA is represnted by a threshold setpoint of 185); the range is [0,…,200].
Note 2: BTU type sensors use 3 consecutive sensors. The Threshold setpoints for 3 consecutive BTU sensors form a 24-bit scale factor (LSB to MSB) which the AIM uses to compute BTUs. The BTU scale factor is computed as follows:
B T U s c a le fa c to r =
w h e re
is th e s e n s o r in p u t in m A c o rre s p o n d in g to a te m p e ra tu re o f d e g re e s ,
is th e s e n s o r in p u t in m A c o rre s p o n d in g to a te m p e ra tu re o f d e g re e s ,
is th e s e n s o r in p u t in m A c o r re s p o n d in g to a f lo w o f
is th e s e n s o r in p u t in m A c o rre s p o n d in g to a f lo w o f
2 0 4 7 2 * 3 6 0 0
−
−
−
−5 0 0 2 0 2 0* * *
H ig h L ow
m A H ig h m A L ow*
H ig h L ow
m AH ig h m A L ow
m A H ig h H ig h
m A L ow L ow
m AH ig h H ig h
A L ow L ow
τ ττ τ
τ ττ τ
µ
Γ ΓΓ Γ
Γ ΓΓ Γ
INCOM System Communications, June 2004 503-29
Communications Protocol for the Analog Input Module
SLAVE ACTION Description (3 D 0)
Byte2 Byte1 Byte0 Definition 0 0 2 Reset Alarm
0 0 80H Snapshot Energy Buffer Command
0 4 X Reset Sensor #x Running Total Value
(x = Sensor #, 0 resets all sensors)
0 5 X Reset Sensor #x Min/Max Values
(x = Sensor #, 0 resets all sensors)
3 0 2 Reset INCOM Slave-Interface Statistics
3 0 3 Reset Product Statistics
3 0 6 Acknowledge Reset (See (3 C C) Description)
4 1 X Activate Relay output #X (X = relay number: 1;
X = 0 activates all)
4 2 X Deactivate relay output #X (X = relay number: 1;
X = 0 deactivates all)
Note 1: BTU sensors are configured from 3 consecutive sensors:
The first sensor measures the flow, ♦
♦
♦
the second measures the low temperature (temperature in the reverse direction,)
the third measures the high temperature (temperature in the forward direction).
If the Reset Sensor #x Min/Max Values is sent to the first sensor (flow/Forward BTU), the AIM will automatically reset the values for the second and third BTU sensors (low and high temperature, Reverse and Net BTU).
503-30 INCOM System Communications, June 2004
Communications Protocol for the Analog Input Module
Receive Setpoints Buffer Descriptions (3 F 9) Note 1: The device performs range-checking on the setpoints as they are downloaded. If
a setpoint is deemed valid, the device responds with a (3 1 0) ACK message. If an out-of-range setpoint value is detected, the device responds with a (3 1 B) NACK message, discards previously received setpoints, and will cease accepting additional setpoints until the (3 F 9) command is re-sent.
Note 2: The device responds to the last data message with one of the following messages:
Response Definition
(3 1 0) ACK The new setpoints were accepted. (The checksum was valid.) The device will proceed with saving the setpoints to NVRAM (i.e., EEPROM).
(3 1 A) NACK The new setpoints were not accepted due to a communications checksum error.
Note 3: It is recommended that the INCOM master read the device setpoints subsequent to their download. A check should be made to verify the new settings match the downloaded values.
Note 4: The Block # field of Message 1 has the following meaning:
Block #0 assigns device configuration. ♦
♦
♦
♦
Block #1-16 stores reserved data for sensors 1-32.
Block #17-32 stores reserved data.
Block #33 assigns configuration for sensors 1-32.
INCOM System Communications, June 2004 503-31
Communications Protocol for the Analog Input Module
Receive Setpoints Buffer Descriptions (3 F 9) – Continued
Assign Device Configuration (Block #0)
Message Byte Description 1 Byte0 Number of additional data messages=4
Byte1 Block #0 = 0
Byte2 Reserved = 0
2 Byte0 Firmware Revision
Byte1 Firmware Version
Byte2 Reserved = 0
3 Byte0 Synch Type (type of demand window synchronization)
Value Definition
0 N/A
1 N/A
2 IMPACC
Byte1 Reserved = 0
Byte2 Reserved = 0
4 Reserved = 0
5 Byte0 LSB of checksum
Byte1 MSB of checksum
Byte2 Complement of LSB of checksum
503-32 INCOM System Communications, June 2004
Communications Protocol for the Analog Input Module
Receive Setpoints Buffer Descriptions (3 F 9) – Continued
Store Reserved Sensor Data (Block #xx) 1 = Block #1 (Sensors 1-2) 2 = Block #2 (Sensors 3-4)
3 = Block #3 (Sensors 5-6) 4 = Block #4 (Sensors 7-8)
5 = Block #5 (Sensors 9-10) 6 = Block #6 (Sensors 11-12)
7 = Block #7 (Sensors 13-14) 8 = Block #8 (Sensors 15-16)
9 = Block #9 (Sensors 17-18) 10= Block #10 (Sensors 19-20)
11 =Block #11 (Sensors 21-22) 12= Block #12 (Sensors 23-24)
13 =Block #13 (Sensors 25-26) 14= Block #14 (Sensors 27-28)
15 =Block #15 (Sensors 29-30) 16= Block #16 (Sensors 31-32)
Message Byte Description 1 Byte0 Number of additional data messages=42
Byte1 Block # xx
Byte2 Reserved = 0
2 Reserved
3 Reserved
4 Reserved
5 Reserved
.
.
.
42 Reserved
43 Byte0 LSB of checksum
Byte1 MSB of checksum
Byte2 Complement of LSB of checksum
INCOM System Communications, June 2004 503-33
Communications Protocol for the Analog Input Module
Receive Setpoints Buffer Descriptions (3 F 9) -- Continued
Store Reserved Data (Block #xx)
Message Byte Description 1 Byte0 Number of additional data messages=42
Byte1 Block # xx
Byte2 Reserved = 0
2 Reserved
3 Reserved
4 Reserved
5 Reserved
.
.
.
42 Reserved
43 Byte0 LSB of checksum
Byte1 MSB of checksum
Byte2 Complement of LSB of checksum
503-34 INCOM System Communications, June 2004
Communications Protocol for the Analog Input Module
Receive Setpoints Buffer Descriptions (3 F 9) -- Continued
Assign Sensor Configuration (Block #33) – Continued
Message Byte Description 1 Byte0 Number of additional data messages=44
Byte1 Reserved = 33
Byte2 Reserved = 0
2 Byte0 Bit Definition
B0-B3 Sensor #1 Type
B4-B5 Reserved = 0
B6 Sensor #1 Input Range
B7 Sensor #1 Phase Direction
Byte1 Sensor #1 Threshold
Byte2 Sensor #1 Demand Window #1
3 Byte0 Sensor #1 Demand Window #2
Byte1 Bit Definition
B0-B3 Sensor #2 Type
B4-B5 Reserved = 0
B6 Sensor #2 Input Range
B7 Sensor #2 Phase Direction
Byte2 Sensor #2 Threshold
4 Byte0 Sensor #2 Demand Window #1
Byte1 Sensor #2 Demand Window #2
Byte2 Bit Definition
B0-B3 Sensor #3 Type
B4-B5 Reserved = 0
B6 Sensor #3 Input Range
B7 Sensor #3 Phase Direction
5 Byte0 Sensor #3 Threshold
Byte1 Sensor #3 Demand Window #1
Byte2 Sensor #3 Demand Window #2
. . .
INCOM System Communications, June 2004 503-35
Communications Protocol for the Analog Input Module
Receive Setpoints Buffer Descriptions (3 F 9) – Continued
Assign Sensor Configuration (Block #33) – Continued Message Byte Description
43 Byte1 Bit Definition
B0-B3 Sensor #32 Type
B4-B5 Reserved = 0
B6 Sensor #32 Input Range
B7 Sensor #32 Phase Direction
Byte2 Sensor #32 Threshold
44 Byte0 Sensor #32 Demand Window #1
Byte1 Sensor #32 Demand Window #2
Byte2 Reserved = 0
45 Byte0 LSB of checksum
Byte1 MSB of checksum
Byte2 Complement of LSB of checksum
503-36 INCOM System Communications, June 2004
Communications Protocol for the Analog Input Module
Profile Data Buffer Description (3 C F)
Transmit Sensor Configuration (N = 50xx02H) See Note 1 below.
BYTE2 (most significant byte) 8010 = Transmit profile information
BYTE1 1 = Block #1 (Sensors 1-2) 2 = Block #2 (Sensors 3-4)
3 = Block #3 (Sensors 5-6) 4 = Block #4 (Sensors 7-8)
5 = Block #5 (Sensors 9-10) 6 = Block #6 (Sensors 11-12)
7 = Block #7 (Sensors 13-14) 8 = Block #8 (Sensors 15-16)
9 = Block #9 (Sensors 17-18) 10= Block #10 (Sensors 19-20)
11 =Block #11 (Sensors 21-22) 12= Block #12 (Sensors 23-24)
13 =Block #13 (Sensors 25-26) 14= Block #14 (Sensors 27-28)
15 =Block #15 (Sensors 29-30) 16= Block #16 (Sensors 31-32)
BYTE0 2 = Sensor configuration data
Message Byte Name Description Unit 1 Byte0 Number of additional data messages=42
Byte1 Block # xx
Byte2 Reserved = 0
1ST Sensor in Block 2 Byte0 X1 LSB IEEE float
Byte1 X1
Byte2 X1
3 Byte0 X1 MSB
Byte1 Y1 LSB IEEE float
Byte2 Y1
4 Byte0 Y1
Byte1 Y1 MSB
Byte2 X2 LSB IEEE float
INCOM System Communications, June 2004 503-37
Communications Protocol for the Analog Input Module
Profile Data Buffer Description (3 C F) – Continued
Transmit Sensor Configuration (N = 50xx02H) – Continued Message Byte Name Description Unit
5 Byte0 X2
Byte1 X2
Byte2 X2 MSB
6 Byte0 Y2 LSB IEEE float
Byte1 Y2
Byte2 Y2
7 Byte0 Y2 MSB
Byte1 Sensor Description, 1st ASCII character
Byte2 Sensor Description, 2nd ASCII character
8 Byte0 Sensor Description, 3rd ASCII character
Byte1 Sensor Description, 4th ASCII character
Byte2 Sensor Description, 5th ASCII character
9 Byte0 Sensor Description, 6th ASCII character
Byte1 Sensor Description, 7th ASCII character
Byte2 Sensor Description, 8th ASCII character
10 Byte0 Sensor Description, 9th ASCII character
Byte1 Sensor Description, 10th ASCII character
Byte2 Sensor Description, 11th ASCII character
11 Byte0 Sensor Description, 12th ASCII character
Byte1 Sensor Description, 13th ASCII character
Byte2 Sensor Description, 14th ASCII character
12 Byte0 Sensor Description, 15th ASCII character
Byte1 = 0 (ASCIIZ terminator)
Byte2 Units Text, 1st ASCII character
503-38 INCOM System Communications, June 2004
Communications Protocol for the Analog Input Module
Profile Data Buffer Description (3 C F) – Continued
Transmit Sensor Configuration (N = 50xx02H) – Continued Message Byte Name Description Unit 13 Byte0 Units Text, 2nd ASCII character
Byte1 Units Text, 3rd ASCII character
Byte2 Units Text, 4th ASCII character
14 Byte0 Units Text, 5th ASCII character
Byte1 Units Text, 6th ASCII character
Byte2 Units Text, 7th ASCII character
15 Byte0 Units Text, 8th ASCII character
Byte1 Reserved = 0 (ASCIIZ terminator)
Byte2 Byte2 Sensor Scale Factor (1 for BTU, Runtime, 100 for others)
16 Byte0 Sensor Snapshot Logging (1=Enabled)
Byte1 Reserved = 0
Byte2 Reserved = 0
17 Reserved = 0
18 Reserved = 0
19 Reserved = 0
20 Reserved=0
21 Reserved=0
2nd Sensor in Block 22 Byte0 X1 LSB IEEE float
Byte1 X1
Byte2 X1
23 Byte0 X1 MSB
Byte1 Y1 LSB IEEE float
Byte2 Y1
INCOM System Communications, June 2004 503-39
Communications Protocol for the Analog Input Module
Profile Data Buffer Description (3 C F) – Continued
Transmit Sensor Configuration (N = 50xx02H) – Continued
Message Byte Name Description Unit
24 Byte0 Y1
Byte1 Y1 MSB
Byte2 X2 LSB IEEE float
25 Byte0 X2
Byte1 X2
Byte2 X2 MSB
26 Byte0 Y2 LSB IEEE float
Byte1 Y2
Byte2 Y2
27 Byte0 Y2 MSB
Byte1 Sensor Description, 1st ASCII character
Byte2 Sensor Description, 2nd ASCII character
28 Byte0 Sensor Description, 3rd ASCII character
Byte1 Sensor Description, 4th ASCII character
Byte2 Sensor Description, 5th ASCII character
29 Byte0 Sensor Description, 6th ASCII character
Byte1 Sensor Description, 7th ASCII character
Byte2 Sensor Description, 8th ASCII character
30 Byte0 Sensor Description, 9th ASCII character
Byte1 Sensor Description, 10th ASCII character
Byte2 Sensor Description, 11th ASCII character
31 Byte0 Sensor Description, 12th ASCII character
Byte1 Sensor Description, 13th ASCII character
Byte2 Sensor Description, 14th ASCII character
503-40 INCOM System Communications, June 2004
Communications Protocol for the Analog Input Module
Profile Data Buffer Description (3 C F) – Continued
Transmit Sensor Configuration (N = 50xx02H) – Continued Message Byte Name Description Unit
32 Byte0 Sensor Description, 15th ASCII character
Byte1 = 0 (ASCIIZ terminator)
Byte2 Units Text, 1st ASCII character
33 Byte0 Units Text, 2nd ASCII character
Byte1 Units Text, 3rd ASCII character
Byte2 Units Text, 4th ASCII character
34 Byte0 Units Text, 5th ASCII character
Byte1 Units Text, 6th ASCII character
Byte2 Units Text, 7th ASCII character
35 Byte0 Units Text, 8th ASCII character
Byte1 Reserved = 0 (ASCIIZ terminator)
Byte2 Sensor Scale Factor(1 for BTU, Runtime, 100 for others)
36 Byte0 Sensor Snapshot Logging (1=Enabled)
Byte1 Reserved = 0
Byte2 Reserved = 0
37 Reserved = 0
38 Reserved = 0
39 Reserved = 0
40 Reserved = 0
41 Reserved = 0
42 Reserved=0
43 Byte0 LSB of checksum
Byte1 MSB of checksum
Byte2 Complement of LSB of checksum
Note 1: The values in this buffer are for use by the INCOM master only. The AIM maintains the values in these buffers in non-volatile memory. These values are not used or modified by the AIM in any way.
INCOM System Communications, June 2004 503-41
Communications Protocol for the Analog Input Module
Receive Setpoints Buffer Descriptions (3 F 9)
Store Sensor Scale Factors (Block #xx) 1 = Block #1 (Sensors 1-2) 2 = Block #2 (Sensors 3-4)
3 = Block #3 (Sensors 5-6) 4 = Block #4 (Sensors 7-8)
5 = Block #5 (Sensors 9-10) 6 = Block #6 (Sensors 11-12)
7 = Block #7 (Sensors 13-14) 8 = Block #8 (Sensors 15-16)
9 = Block #9 (Sensors 17-18) 10= Block #10 (Sensors 19-20)
11 =Block #11 (Sensors 21-22) 12= Block #12 (Sensors 23-24)
13 =Block #13 (Sensors 25-26) 14= Block #14 (Sensors 27-28)
15 =Block #15 (Sensors 29-30) 16= Block #16 (Sensors 31-32)
Message Byte Name Description Format 1 Byte0 Number of additional data messages=42
Byte1 Block # xx
Byte2 Reserved = 0
2 Byte0 X12 32-bit coefficient LSB (1st Sensor in block)
Byte1 X12
Byte2 X12
3 Byte0 X12 32-bit coefficient MSB
Byte1 X11 32-bit coefficient LSB
Byte2 X11
4 Byte0 X11
Byte1 X11 32-bit coefficient MSB
Byte2 X10 32-bit coefficient LSB
5 Byte0 X10
Byte1 X10
Byte2 X10 32-bit coefficient MSB
6 Byte0 X9 32-bit coefficient LSB
Byte1 X9
Byte2 X9
503-42 INCOM System Communications, June 2004
Communications Protocol for the Analog Input Module
Receive Setpoints Buffer Descriptions (3 F 9)
Store Sensor Scale Factors (Block #xx) – Continued
Message Byte Name Description Format
7 Byte0 X9 32-bit coefficient MSB
Byte1 X8 32-bit coefficient LSB
Byte2 X8
9 Byte0 X8
Byte1 X8 32-bit coefficient MSB
Byte2 X7 32-bit coefficient LSB
10 Byte0 X7
Byte1 X7
Byte2 X7 32-bit coefficient MSB
11 Byte0 X6 32-bit coefficient LSB
Byte1 X6
Byte2 X6
12 Byte0 X6 32-bit coefficient MSB
Byte1 X5 32-bit coefficient LSB
Byte2 X5
13 Byte0 X5
Byte1 X5 32-bit coefficient MSB
Byte2 X4 32-bit coefficient LSB
14 Byte0 X4
Byte1 X4
Byte2 X4 32-bit coefficient MSB
15 Byte0 X3 32-bit coefficient LSB
Byte1 X3
Byte2 X3
INCOM System Communications, June 2004 503-43
Communications Protocol for the Analog Input Module
Receive Setpoints Buffer Descriptions (3 F 9)
Store Sensor Scale Factors (Block #xx) – Continued
Message Byte Name Description Format 16 Byte0 X3 32-bit coefficient MSB
Byte1 X2 32-bit coefficient LSB
Byte2 X2
17 Byte0 X2
Byte1 X2 32-bit coefficient MSB
Byte2 X1 32-bit coefficient LSB
18 Byte0 X1
Byte1 X1
Byte2 X1 32-bit coefficient MSB
19 Byte0 X0 32-bit coefficient LSB
Byte1 X0
Byte2 X0
20 Byte0 X0 32-bit coefficient MSB
Byte1 X12 32-bit coefficient LSB (2nd Sensor in block) Byte2 X12
21 Byte0 X12
Byte1 X12 32-bit coefficient MSB
Byte2 X11 32-bit coefficient LSB
22 Byte0 X11
Byte1 X11
Byte2 X11 32-bit coefficient MSB
23 Byte0 X10 32-bit coefficient LSB
Byte1 X10
Byte2 X10
503-44 INCOM System Communications, June 2004
Communications Protocol for the Analog Input Module
Receive Setpoints Buffer Descriptions (3 F 9)
Store Sensor Scale Factors (Block #xx) – Continued
Message Byte Name Description Format 24 Byte0 X10 32-bit coefficient MSB
Byte1 X9 32-bit coefficient LSB
Byte2 X9
25 Byte0 X9
Byte1 X9 32-bit coefficient MSB
Byte2 X8 32-bit coefficient LSB
26 Byte0 X8
Byte1 X8
Byte2 X8 32-bit coefficient MSB
27 Byte0 X7 32-bit coefficient LSB
Byte1 X7
Byte2 X7
28 Byte0 X7 32-bit coefficient MSB
Byte1 X6 32-bit coefficient LSB
Byte2 X6
29 Byte0 X6
Byte1 X6 32-bit coefficient MSB
Byte2 X5 32-bit coefficient LSB
30 Byte0 X5
Byte1 X5
Byte2 X5 32-bit coefficient MSB
31 Byte0 X4 32-bit coefficient LSB
Byte1 X4
Byte2 X4
INCOM System Communications, June 2004 503-45
Communications Protocol for the Analog Input Module
Receive Setpoints Buffer Descriptions (3 F 9)
Store Sensor Scale Factors (Block #xx) – Continued
Message Byte Name Description Format 32 Byte0 X4 32-bit coefficient MSB
Byte1 X3 32-bit coefficient LSB
Byte2 X3
33 Byte0 X3
Byte1 X3 32-bit coefficient MSB
Byte2 X2 32-bit coefficient LSB
34 Byte0 X2
Byte1 X2
Byte2 X2 32-bit coefficient MSB
35 Byte0 X1 32-bit coefficient LSB
Byte1 X1
Byte2 X1
36 Byte0 X1 32-bit coefficient MSB
Byte1 X0 32-bit coefficient LSB
Byte2 X0
37 Byte0 X0
Byte1 X0 32-bit coefficient MSB
Byte2 Reserved = 0
38 Reserved = 0
39 Reserved = 0
40 Reserved = 0
41 Reserved = 0
42 Reserved = 0
43 Byte0 LSB of checksum
Byte1 MSB of checksum
Byte2 Complement of LSB of checksum
503-46 INCOM System Communications, June 2004
Communications Protocol for the Analog Input Module
CHANGE RECORD Revision Date Changes
1.00 6/28/02 Taken from IL 17384 Revision 3.10 (June 2002) Part F; made into separate document for inclusion in Revision 3.20.
INCOM System Communications, June 2004 503-47
Communications Protocol for the Analog Input Module
503-48 INCOM System Communications, June 2004
This page intentionally left blank.
Communications Protocol for the IQ Transfer II
COMMUNICATIONS PROTOCOL – IQ TRANSFER II
Fast Status (3 0 0) Division Code = 4
Communications Version = 0 Initial Phase 2 version
= 1 - Check breaker auxilliary contacts to confirm opening and closing
- Remove Closed Transition phase angle difference setpoint
- Remove In-Phase Transition phase angle difference setpoint
= 2 Incorporated TDEF Timer
= 3 Incorporate Slave Action commands for Go To
Emergency and Cancel Go To Emergency
= 10 TDEN timer setpoint range extended to 8 hours
Product ID: 21
Status Bits: Bit Definition
S7-S6 0 0 On Good Source (see Bits S2, S5)
0 1 Generator Start
1 0 Transferred (see Bits S2, S5)
1 1 In Alarm
S5 1= Source 2 is connected.
S4 1= Powered on since last Fast Status
S3 1= Unread Time-Stamped Transfer Buffer is available.
S2 1= Source 1 is connected.
S1 1= Source 2 is available.
S0 1= Source 1 is available.
Supported Commands Reference Section (3 0 0) Fast Status Part A, 5.2.3, this section
(3 0 3) Transmit All Standard Buffers Part A, 5.2.8
(3 0 6) Transmit Load Line-to-Line Voltage Buffer Part A, 5.2.10
(3 C 8) Transmit Flags Buffer Part A, 5.2.19, this section
(3 C 9) Transmit Setpoints Buffer Part A, 5.2.20, this section
(3 C A) Transmit Synchronization Buffer This section
INCOM System Communications, June 2004 504-1
Communications Protocol for the IQ Transfer II
Supported Commands – Continued Reference Section
(3 C B) Transmit Time-Stamped Transfer Buffer Part A, 5.2.21, this section
(3 C C) Transmit Run Time and Transfer Count Buffer This section
(3 C D) Transmit L-L Voltage and Frequency Buffer This section
(3 D 0) Slave Action Part A, 5.2.23.1, 5.3.7, this section
(3 D 8) Receive Current Date and Time Part A, 5.2.25.1
(3 F 9) Download Setpoints Part A, 5.2.26.2, this section
(D E 3) Broadcast Synchronize RTC Part A, 5.2.27, this section
504-2 INCOM System Communications, June 2004
Communications Protocol for the IQ Transfer II
FLAGS Buffer Description (3 C 8) Message Byte Name Description 1 Byte0 Number of additional data messages = 6
Byte1 Flags1: Reason in alarm
Value Definition 0 Unknown
1 Preferred source became available
2 Over voltage on connected source
3 Under voltage on connected source
4 Over frequency on connected source
5 Under frequency on connected source
6 Exercised Generator
7 Test
8 Manual Re-Transfer
9 Communications
10 Go to Neutral
11 In Program Mode
12 Option or setpoint error
13 Load Shed from Source 2
14 Go To Emergency
15 Lockout
16 Failed to synch (phase angle diff out of spec)
17 Failed to synchronize (frequency diff out of spec)
18 Failed to synchronize (voltage diff out of spec)
Byte2 Flags2: Current mode (status)
Value Definition 0 Power-up
1 Connected to Source 1
2 TDES timeout (Source 2)
3 TDNE timeout
4 Neutral timeout
5 Waiting for transfer Source 1 to Source 2
6 Connected to Source 2
7 TDES timeout (Source 1)
8 TDEN timeout
9 Neutral timeout
10 Waiting for transfer Source 2 to Source 1
INCOM System Communications, June 2004 504-3
Communications Protocol for the IQ Transfer II
FLAGS Buffer Description (3 C 8) – Continued
Message Byte Name Description 2 Reserved
3 Byte0 Flags3: Bit Definition
B0 Contact Input 1 – Breaker 1 closed (source 1 connected)
B1 Contact Input 2 – Breaker 2 closed (source 2 connected)
B2 Contact Input 3 – Lockout
B3 Contact Input 4 – Go To Emergency
B4 Contact Input 5 – Bypass TDNE/TDEN timers
B5 Contact Input 6 – Return to Neutral (Ext. lockout)
B6 Contact Input 7 – Manual Transfer
B7 Contact Input 8 – Load Shed from Source 2
Byte1 Flags4: Bit Definition
B0 Relay Output 1 – Close Source 1 breaker
B1 Relay Output 2 – Close Source 2 breaker
B2 Relay Output 3 – TDN Source 1 breaker
B3 Relay Output 4 – TDN Source 2 breaker
B4 Relay Output 5 – Normal power (source 1) available
B5 Relay Output 6 – Emergency power (src 2) available
B6 Relay Output 7 – Alarm
B7 DIP Switch 1– Program Mode
Byte2 Flags5: Bit Definition
B0 Relay Output 9 – Start generator for source 1
B1 Relay Output 10 – Start generator for source 2
B2 Preferred Source (1=Source 1 is preferred.)
B3 Preferred Source (1=Source 2 is preferred.)
B4 Load Energized (1=energized, 0=not energized)
B5 Mode (1=ATS is in Auto Mode)
B6 Mode (1=ATS is in Test Mode)
B7 Mode (1=ATS is in Program Mode)
504-4 INCOM System Communications, June 2004
Communications Protocol for the IQ Transfer II
FLAGS Buffer Description (3 C 8) – Continued
Message Byte Name Description 4 Byte0 Flags6: Bit Definition
B0 Addressable Relay #1 IN1
B1 Addressable Relay #2 IN1
B2 Addressable Relay #3 IN1
B3 Addressable Relay #4 IN1
B4 Addressable Relay #5 IN1
B5 Addressable Relay #6 IN1
B6 Addressable Relay #7 IN1
B7 Addressable Relay #8 IN1
Byte1 Flags7: Bit Definition
B0 Addressable Relay #9 IN1
B1 Addressable Relay #10 IN1
B2 Addressable Relay #11 IN1
B3-B7 Reserved
Byte2 Flags8: Bit Definition
B0 Bypass Timer Transfer Enabled (1=enabled)
B1 Closed/In-Phase Transition Option
B2-B7 Reserved
5 Reserved
6 Reserved
7 Reserved
INCOM System Communications, June 2004 504-5
Communications Protocol for the IQ Transfer II
SETPOINTS Buffer Description (3 C 9)
Message Byte Description 1 Byte0 Number of additional data messages = 42
Byte1 Firmware Revision
Byte2 Firmware Version
*** Factory-Set Options *** 2 Byte0 0. TDES – Time Delay Engine Start 1=enabled
Byte1 1. TDNE – Time Delay Norm to Emerg. 1=enabled
Byte2 2. TDEN – Time Delay Emerg. to Norm 1=enabled
3 Byte0 3. TDEC – Time Delay Engine Cooldown 1=enabled
Byte1 4. Source 2 under frequency monitoring 1=enabled
Byte2 5. Source 2 over frequency monitoring 0=disabled 1=enabled
4 Byte0 6. Source 2 over voltage monitoring 0=disabled 1=enabled
Byte1 7. Source 2 under voltage monitoring 1=enabled
Byte2 8. Transfer Time Delay Bypass TDEN/TDNE pushbutton
0=disabled 1=TDEN bypass
2=TDNE bypass 3=TDEN/TDNE (bypass either timer)
5 Byte0 9. User-Selectable Preferred Source 0=disabled 1=enabled
Byte1 10. Plant Exerciser 0=disabled 1=enabled
Byte2 11. Source 1 under frequency monitoring 0=disabled 1=enabled
6 Byte0 12. Source 1 over frequency monitoring 0=disabled 1=enabled
Byte1 13. Source 1 over voltage monitoring 0=disabled 1=enabled
Byte2 14. Type of Operation: 0=Automatic
1=User-Selectable
7 Byte0 15. TDN Time Delay Neutral 0=disabled 1=enabled
Byte1 16. TDN Neutral Load Sense Delay:
0=disabled
1=enabled (2-30% of nominal voltage)
Note: Options 15 and 16 are mutually exclusive
Byte2 17. Pre-Transfer Signal on subnetwork 0=disabled 1=enabled
504-6 INCOM System Communications, June 2004
Communications Protocol for the IQ Transfer II
SETPOINTS Buffer Description (3 C 9) – Continued
Message Byte Description
8 Byte0 18. Remote sequencing on subnetwork 0=disabled 1=enabled
Byte1 19. Service Entrance
0=disabled – don’t recognize Go-to-neutral input
1=enabled – respond to Go-to-neutral
Byte2 20. Over current protection 0=disabled 1=enabled
9 Byte0 21. Type of switch 0=SPB, 1=Motor driven, 2=DS, 3=WLI
Byte1 22. User-selectable PT Ratio 0=disabled 1=enabled
Byte2 23. Load shed from source 2 0=disabled 1=enabled
10 Byte0 24. Go To Emergency 0=disabled 1=enabled
Byte1 25. Closed/In-Phase Transition
0=Open Transition only
1=Open/In-Phase Transition
2=Open/In-Phase/Closed Transition
3=Closed Transition only
Byte2 Option 26. Reserved
*** User-Programmable Setpoints *** 11 Byte0 0. TDES Timer – low byte Range: 0-120 seconds
Byte1 0. TDES Timer – high byte
Byte2 1. TDNE Timer – low byte Range: 0-1800 seconds
12 Byte0 1. TDNE Timer – high byte
Byte1 2. TDEN Timer – low byte Range:0-1800 s. (Comm Ver 0-9)
Byte2 2. TDEN Timer – high byte 0-28800 s. (Comm Ver 10-15)
13 Byte0 3. TDEC Timer – low byte Range: 0-1,800 seconds
Byte1 3. TDEC Timer – high byte
Byte2 4. Nominal frequency – low byte Range: 50 or 60 (hertz x10)
14 Byte0 4. Nominal frequency – high byte
Byte1 5. Nominal voltage – low byte Range: 110-600 volts @ 50Hz
Byte2 5. Nominal voltage – high byte 120-600 volts @ 60Hz
See Note 1 and Note 2.
INCOM System Communications, June 2004 504-7
Communications Protocol for the IQ Transfer II
SETPOINTS Buffer Description (3 C 9) – Continued
Message Byte Description
15 Byte0 6. Source 1 under voltage dropout level (in volts) – low byte
Byte1 6. Source 1 under voltage dropout level (in volts) – high byte
Range: 50-97% of nominal voltage (message 14)
Byte2 7. Source 2 under voltage dropout level (in volts) – low byte
16 Byte0 7. Source 2 under voltage dropout level (in volts) – high byte
Range: 50-97% of nominal voltage (setpoint 5) Byte1 8. Source 1 under voltage pickup level (in volts) – low byte
Byte2 8. Source 1 under voltage pickup level (in volts) – high byte
Range: dropout level+2% - 99% of nominal voltage.
17 Byte0 9. Source 2 under voltage pickup level (in volts) – low byte
Byte1 9. Source 2 under voltage pickup level (in volts) – high byte
Range: dropout level+2% - 99% of nominal voltage.
Byte2 10. Source 1 over voltage dropout level (in volts) – low byte
18 Byte0 10. Source 1 over voltage dropout level (in volts) – high byte
Range: 105-120% of nominal voltage.
Valid only if Option 13 is enabled.
Byte1 11. Source 2 over voltage dropout level (in volts) – low byte
Byte2 11. Source 2 over voltage dropout level (in volts) – high byte
Range: 105-120% of nominal voltage.
Valid only if Option 6 is enabled.
19 Byte0 12. Source 1 over voltage pickup level (in volts) – low byte
Byte1 12. Source 1 over voltage pickup level (in volts) – high byte
Range: 103% of nominal voltage – dropout level-2%
Valid only if Option 13 is enabled.
Byte2 13. Source 2 over voltage pickup level (in volts) – low byte
Note 1: If the PT Ratio option is enabled, then the system nominal voltage must be either 120 VAC for a system frequency of 60Hz, or 110 VAC if the system frequency is 50Hz. The system voltage can not be changed from either 120 or 110 VAC.
Note 2: If the PT Ratio option is enabled, when the system nominal frequency is changed, the nominal system voltage must change and with it the voltage dropout and pickup values must also change to the default values.
504-8 INCOM System Communications, June 2004
Communications Protocol for the IQ Transfer II
SETPOINTS Buffer Description (3 C 9) – Continued
Message Byte Description
20 Byte0 13. Source 2 over voltage pickup level (in volts) – high byte
Range: 103% of nominal voltage – dropout level-2% Valid only if Option 6 is enabled.
Byte1 14. Source 1 under frequency dropout level (hertz x10) – low byte
Byte2 14. Source 1 under frequency dropout level (hertz x10) – high byte
Range: 90-97% of nominal frequency
Valid only if Option 11 is enabled.
21 Byte0 15. Source 2 under frequency dropout level (hertz x10) – low byte
Byte1 15. Source 2 under frequency dropout level (hertz x10) – high byte
Range: 90-97% of nominal frequency
Byte2 16. Source 1 under frequency pickup level (hertz x10) – low byte
22 Byte0 16. Source 1 under frequency pickup level (hertz x10) – high byte
Range: dropout level+1Hz - 99% of nominal frequency
Valid only if Option 11 is enabled.
Byte1 17. Source 2 under frequency pickup level (hertz x10) – low byte
Byte2 17. Source 2 under frequency pickup level (hertz x10) – high byte
Range: dropout level+1Hz - 99% of nominal frequency
23 Byte0 18. Source 1 over frequency dropout level (hertz x10) – low byte
Byte1 18. Source 1 over frequency dropout level (hertz x10) – high byte
Range: 103-110% of nominal frequency
Valid only if Option 12 is enabled.
Byte2 19. Source 2 over frequency dropout level (hertz x10) – low byte
INCOM System Communications, June 2004 504-9
Communications Protocol for the IQ Transfer II
SETPOINTS Buffer Description (3 C 9) – Continued
Message Byte Description 24 Byte0 19. Source 2 over frequency dropout level (hertz x10) – high byte
Range: 103-110% of nominal frequency
Valid only if Option 5 is enabled.
Byte1 20. Source 1 over frequency pickup level (hertz x10) – low byte
Byte2 20. Source 1 over frequency pickup level (hertz x10) – high byte
Range: 101% of nominal frequency – dropout level-1Hz
Valid only if Option 12 is enabled.
25 Byte0 21. Source 2 over frequency pickup level (hertz x10) – low byte
Byte1 21. Source 2 over frequency pickup level (hertz x10) – high byte
Range: 101% of nominal frequency – dropout level-1Hz
Valid only if Option 5 is enabled.
Byte2 22. TDN with Load Sensing – low byte 0=no, 1=yes
26 Byte0 22. TDN with Load Sensing – high byte
Valid only if Option 16 is enabled.
Byte1 23. TDN Time delay neutral timer – low byte Range:
Byte2 23. TDN Time delay neutral timer – high byte 0-120 seconds
Valid only if Option 15 is enabled.
27 Byte0 24. Load voltage decay threshold (volts) – low byte
Byte1 24. Load voltage decay threshold (volts) – high byte
Range: 2-30% of nominal voltage
Valid only if Option 16 is enabled and Setpoint 22
is set to 1 (with load sensing).
Byte2 25. Preferred source selection – low byte
28 Byte0 25. Preferred source selection – high byte
Range: 0=no preference, 1=source 1, 2=source 2
Byte1 26. Plant Exerciser – low byte Range: 0=not enabled
Byte2 26. Plant Exerciser – high byte 1=enabled
504-10 INCOM System Communications, June 2004
Communications Protocol for the IQ Transfer II
SETPOINTS Buffer Description (3 C 9) – Continued
Message Byte Description
29 Byte0 27. Plant Exerciser Load Transfer – low byte 0=not enabled
Byte1 27. Plant Exerciser Load Transfer – high byte 1=enabled
Byte2 28. Plant Exerciser day of week – low byte
30 Byte0 28. Plant Exerciser day of week – high byte
Range: 1-7, 1=Sunday, 2=Monday, etc.
Byte1 29. Plant Exerciser hour of day – low byte
Byte2 29. Plant Exerciser hour of day – high byte
Range: 0-23 hour
31 Byte0 30. Plant Exerciser minute – low byte
Byte1 30. Plant Exerciser minute – high byte
Range: 0-59 minute
Byte2 31. Manual re-transfer mode – low byte 0=auto
32 Byte0 31. Manual re-transfer mode – high byte 1=pushbutton return
Byte1 32. Commit to transfer in TDNE – low byte 0=not committed
Byte2 32. Commit to transfer in TDNE – high byte 1=committed
Setpoint is valid only if TDNE (Option 1) is enabled.
33 Byte0 33. Test mode engine start only – low byte 0=no load transfer
Byte1 33. Test mode engine start only – high byte 1=load transfer
2=Disable test
Byte2 34. Engine run test time (in minutes) – low byte
34 Byte0 34. Engine run test time (in minutes) – high byte
Range: 0-600 minutes
Byte1 35. Subnetwork pre-transfer time (in seconds) – low byte
Byte2 35. Subnetwork pre-transfer time (in seconds) – high byte
Range: 1-120 sec., Valid only if Option 17 is enabled.
35 Byte0 36. Number of generators – low byte Range: 0-2
Byte1 36. Number of generators – high byte
Byte2 37. Three-phase or single-phase monitoring – low byte
INCOM System Communications, June 2004 504-11
Communications Protocol for the IQ Transfer II
SETPOINTS Buffer Description (3 C 9) – Continued
Message Byte Description
36 Byte0 37. Three-phase or single-phase monitoring – high byte
Range: 1 or 3
Byte1 38. Subnetwork sequencing timer (in seconds) – low byte
Byte2 38. Subnetwork sequencing timer (in seconds) – high byte
Range: 1-120 sec., Valid only if Option 18 is enabled.
37 Byte0 39. PT Ratio – low byte Read Only; Range: 2 through 500:1
Byte1 39. PT Ratio – high byte Valid only if Option 22 is enabled.
Byte2 40. Closed Transition on/off – low byte 0=not enabled, 1=enabled
38 Byte0 40. Closed Transition on/off – high byte
Valid only if Option 25 is set to 2 or 3.
Byte1 41. Closed Transition phase angle difference – low byte
Comm Ver 1-9: Reserved
Byte2 41. Closed Transition phase angle difference – high byte
Comm Ver 1-9: Reserved
39 Byte0 42. Closed Transition frequency difference – low byte
Byte1 42. Closed Transition frequency difference – high byte
Range: 0.0-0.3 Hz. Valid only if Option 25 is set to 2
or 3 and Setpoint 40 is set to 1 (enabled).
Byte2 43. Closed Transition voltage difference – low byte
40 Byte0 43. Closed Transition voltage difference – high byte
Range: 1-5% of nominal voltage. Valid only if Option 25
is set to 2 or 3 and Setpoint 40 is set to 1 (enabled).
Byte1 44. In-Phase Transition on/off – low byte
Byte2 44. In-Phase Transition on/off – high byte
Valid only if Option 25 is set to 1 or 2.
504-12 INCOM System Communications, June 2004
Communications Protocol for the IQ Transfer II
SETPOINTS Buffer Description (3 C 9) – Continued
Message Byte Description
41 Byte0 45. TDEF Timer – low byte Range: 0-6 seconds
Byte1 45. TDEF Timer – high byte (Comm Ver 2-9)
Comm Ver 0: Message 41 Byte0, Byte1 were
the In-Phase Transition phase angle difference setpoint
Comm Ver 1: Reserved
Byte2 46. In-Phase Transition frequency difference – low byte
42 Byte0 46. In-Phase Transition frequency difference – high byte
Range: 0.0 - 3.0 Hz. Valid only if Option 25 is set to
1 or 2 and Setpoint 44 is set to 1 (enabled).
Byte1 47. Maximum synchronization time (in minutes) – low byte
Byte2 47. Maximum synchronization time (in minutes) – high byte
Range: 1-60 minutes. Valid only if Option 25 is set to
1, 2, or 3 and either Setpoint 40 or Setpoint 44 is set to 1.
43 Byte0 Checksum (sum of previous 42 messages) – low byte
Byte1 Checksum (sum of previous 42 messages) – high byte
Byte2 Complement of checksum of low byte
INCOM System Communications, June 2004 504-13
Communications Protocol for the IQ Transfer II
Synchronization Buffer Description (3 C A)
Message Byte Description Format 1 Byte0 Number of additional data messages = 7
Byte1 Reserved
Byte2 Reserved
2 Voltage difference IMPACC 24-Bit Floating Point
3 Frequency difference IMPACC 24-Bit Floating Point
4 Phase difference IMPACC 24-Bit Floating Point
5 Byte0 SYNCHRONIZATION FLA
Bit Definition
B0 1=Ready to Synchronize
B1-B7 Reserved
Byte1 Reserved
Byte2 Reserved
6 Reserved
7 Reserved
8 Reserved
504-14 INCOM System Communications, June 2004
Communications Protocol for the IQ Transfer II
TIME-STAMPED TRANSFER DATA Buffer Description (3 C B)
Message Byte Description 1 Byte0 Number of additional data messages = 5
Byte1 TRANSFER DATA Buffer number
Byte2 Number of unread Transfer Data buffers
2 Byte0 Reserved
Byte1 Time of transfer – 1/100 second = 0
Byte2 Time of transfer – Hour (0-23 BCD)
3 Byte0 Time of transfer – Minute (0-59 BCD)
Byte1 Time of transfer – Second (0-59 BCD)
Byte2 Time of transfer – Month (1-12 BCD)
4 Byte0 Time of transfer – Day (1-31 BCD)
Byte1 Time of transfer – Year (0-99 BCD)
Byte2 Buffer type = 81H (Transfer event)
5 Buffer supported map = 0
INCOM System Communications, June 2004 504-15
Communications Protocol for the IQ Transfer II
TIME-STAMPED TRANSFER DATA Buffer Description (3 C B) – Continued
Message Byte Description
6 Byte0 Type of Event
Value Definition
1 Open Transition from source 1 to source 2
2 Open Transition from source 2 to source 1
3 In-Phase Transition from source 1 to source 2
4 In-Phase Transition from source 2 to source 1
5 Closed Transition from source 1 to source 2
6 Closed Transition from source 2 to source 1
Byte1 Cause of Event
Value Definition 0 Unknown
1 Preferred source became available
2 Over voltage on connected source
3 Under voltage on connected source
4 Over frequency on connected source
5 Under frequency on connected source
6 Exercised Generator
7 Test
8 Manual Re-Transfer
9 Communications
10 Go to Neutral
11 n/a
12 n/a
13 Load Shed from Source 2
14 rea Protection
15 Lockout
16 Failed to synchronize (phase angle diff out of spec)
17 Failed to synchronize (frequency diff out of spec)
18 Failed to synchronize (voltage diff out of spec)
Byte2 Reserved
504-16 INCOM System Communications, June 2004
Communications Protocol for the IQ Transfer II
Available, Connect, Run Time, and Transfer Count Buffer Description (3 C C)
Message Byte Description 1 Byte0 Number of additional data messages = 11
Byte1 Reserved
Byte2 Reserved
2 Byte0 Source 1 Available Time – Hour LSB
Byte1 Source 1 Available Time – Hour MSB
Byte2 Source 1 Available Time – Minute
3 Byte0 Source 1 Connect Time – Hour LSB
Byte1 Source 1 Connect Time – Hour MSB
Byte2 Source 1 Connect Time – Minute
4 Byte0 Source 1 Run Time – Hour LSB
Byte1 Source 1 Run Time – Hour MSB
Byte2 Source 1 Run Time – Minute
5 Byte0 Source 2 Available Time – Hour LSB
Byte1 Source 2 Available Time – Hour MSB
Byte2 Source 2 Available Time – Minute
6 Byte0 Source 2 Connect Time – Hour LSB
Byte1 Source 2 Connect Time – Hour MSB
Byte2 Source 2 Connect Time – Minute
7 Byte0 Source 2 Run Time – Hour LSB
Byte1 Source 2 Run Time – Hour MSB
Byte2 Source 2 Run Time – Minute
8 Byte0 Number of Transfers (full cycle) – LSB
Byte1 Number of Transfers (full cycle) – MSB
Byte2 Reserved
INCOM System Communications, June 2004 504-17
Communications Protocol for the IQ Transfer II
Available, Connect, Run Time, and Transfer Count Buffer Description (3 C C) – Continued
Message Byte Description
9 Byte0 Load Energized Time – Hour LSB
Byte1 Load Energized Time – Hour MSB
Byte2 Load Energized Time – Minute
10 Reserved
11 Reserved
12 Reserved
Note: Runtime values roll over to zero after reaching the value of 9,999 hours. The number of transfers value rolls over to zero after reaching the value of 9,999 transfers.
504-18 INCOM System Communications, June 2004
Communications Protocol for the IQ Transfer II
Line-to-Line Voltages And Frequency Command Description (3 C D)
Message Byte Description Format 1 Byte0 Number of additional data messages = 8
Byte1 Reserved
Byte2 Reserved
2 Source 1 Phase A-B Voltage IMPACC 24-Bit Floating Point
3 Source 1 Phase B-C Voltage IMPACC 24-Bit Floating Point
4 Source 1 Phase C-A Voltage IMPACC 24-Bit Floating Point
5 Source 1 Frequency (hertz) IMPACC 24-Bit Floating Point
6 Source 2 Phase A-B Voltage IMPACC 24-Bit Floating Point
7 Source 2 Phase B-C Voltage IMPACC 24-Bit Floating Point
8 Source 2 Phase C-A Voltage IMPACC 24-Bit Floating Point
9 Source 2 Frequency (hertz) IMPACC 24-Bit Floating Point
INCOM System Communications, June 2004 504-19
Communications Protocol for the IQ Transfer II
SLAVE ACTION Description (3 D 0)
Byte2 Byte1 Byte0 Definition 0 0 20h Reset Time-Stamped Transfer Data Buffer
0 1 2 Reset Operations Count
0 3 1 Reset Source 1 Available Time
0 3 2 Reset Source 1 Connect Time
0 3 3 Reset Source 1 Runtime
0 3 4 Reset Source 2 Available Time
0 3 5 Reset Source 2 Connect Time
0 3 6 Reset Source 2 Runtime
0 3 7 Reset Load Energized Time
0 3 8 Reset Transfer Status
3 0 0 Advance to the Next Time-Stamped Transfer Buffer
5 0 1 Initiate ATS Test
5 0 2 Bypass TDNE/TDEN (if Option 8 enabled)
5 0 4 Manual Re-Transfer
5 0 5 Cancel ATS Test
5 0 6 Go To Emergency (Comm Version 3 – 9)
5 0 7 Cancel Go To Emergency (Comm Version 3 – 9)
504-20 INCOM System Communications, June 2004
Communications Protocol for the IQ Transfer II
Download Setpoints Description (3 F 9)
Message Byte Description 1 Byte0 Number of additional data messages = 42
Byte1 Reserved
Byte2 Reserved
2 Reserved
3 Reserved
4 Reserved
5 Reserved
6 Reserved
7 Reserved
8 Reserved
9 Reserved
10 Reserved
11 Byte0 0. TDES Timer – low byte
Byte1 0. TDES Timer – high byte
Byte2 1. TDNE Timer – low byte
12 Byte0 1. TDNE Timer – high byte
Byte1 2. TDEN Timer – low byte
Byte2 2. TDEN Timer – high byte
13 Byte0 3. TDEC Timer – low byte
Byte1 3. TDEC Timer – high byte
Byte2 4. Nominal Frequency – low byte
14 Byte0 4. Nominal Frequency – high byte
Byte1 5. Nominal voltage – low byte
Byte2 5. Nominal voltage – high byte
15 Byte0 6. Source 1 under voltage dropout level (in volts) – low byte
Byte1 6. Source 1 under voltage dropout level (in volts) – high byte
Byte2 7. Source 2 under voltage dropout level (in volts) – low byte
INCOM System Communications, June 2004 504-21
Communications Protocol for the IQ Transfer II
Download Setpoints Description (3 F 9) – Continued
Message Byte Description
16 Byte0 7. Source 2 under voltage dropout level (in volts) – high byte
Byte1 8. Source 1 under voltage pickup level (in volts) – low byte
Byte2 8. Source 1 under voltage pickup level (in volts) – high byte
17 Byte0 9. Source 2 under voltage pickup level (in volts) – low byte
Byte1 9. Source 2 under voltage pickup level (in volts) – high byte
Byte2 10. Source 1 over voltage dropout level (in volts) – low byte
18 Byte0 10. Source 1 over voltage dropout level (in volts) – high byte
Byte1 11. Source 2 over voltage dropout level (in volts) – low byte
Byte2 11. Source 2 over voltage dropout level (in volts) – high byte
19 Byte0 12. Source 1 over voltage pickup level (in volts) – low byte
Byte1 12. Source 1 over voltage pickup level (in volts) – high byte
Byte2 13. Source 2 over voltage pickup level (in volts) – low byte
20 Byte0 13. Source 2 over voltage pickup level (in volts) – high byte
Byte1 14. Source 1 under frequency dropout level (hertz x10) – low byte
Byte2 14. Source 1 under frequency dropout level (hertz x10) – high byte
21 Byte0 15. Source 2 under frequency dropout level (hertz x10) – low byte
Byte1 15. Source 2 under frequency dropout level (hertz x10) – high byte
Byte2 16. Source 1 under frequency pickup level (hertz x10) – low byte
22 Byte0 16. Source 1 under frequency pickup level (hertz x10) – high byte
Byte1 17. Source 2 under frequency pickup level (hertz x10) – low byte
Byte2 17. Source 2 under frequency pickup level (hertz x10) – high byte
504-22 INCOM System Communications, June 2004
Communications Protocol for the IQ Transfer II
Download Setpoints Description (3 F 9) – Continued
Message Byte Description
23 Byte0 18. Source 1 over frequency dropout level (hertz x10) – low byte Byte1 18. Source 1 over frequency dropout level (hertz x10) – high byte
Byte2 19. Source 2 over frequency dropout level (hertz x10) – low byte
24 Byte0 19. Source 2 over frequency dropout level (hertz x10) – high byte
Byte1 20. Source 1 over frequency pickup level (hertz x10) – low byte
Byte2 20. Source 1 over frequency pickup level (hertz x10) – high byte
25 Byte0 21. Source 2 over frequency pickup level (hertz x10) – low byte
Byte1 21. Source 2 over frequency pickup level (hertz x10) – high byte
Byte2 22. TDN with Load Sensing – low byte
26 Byte0 22. TDN with Load Sensing – high byte
Byte1 23. TDN Time delay neutral timer – low byte
Byte2 23. TDN Time delay neutral timer – high byte
27 Byte0 24. Load voltage decay threshold (volts) – low byte
Byte1 24. Load voltage decay threshold (volts) – high byte
Byte2 25. Preferred source selection – low byte
28 Byte0 25. Preferred source selection – high byte
Byte1 26. Plant Exerciser – low byte
Byte2 26. Plant Exerciser – high byte
29 Byte0 27. Plant Exerciser Load Transfer – low byte
Byte1 27. Plant Exerciser Load Transfer – high byte
Byte2 28. Plant Exerciser day of week – low byte
30 Byte0 28. Plant Exerciser day of week – high byte
Byte1 29. Plant Exerciser hour of day – low byte
Byte2 29. Plant Exerciser hour of day – high byte
INCOM System Communications, June 2004 504-23
Communications Protocol for the IQ Transfer II
Download Setpoints Description (3 F 9) – Continued
Message Byte Description
31 Byte0 30. Plant Exerciser minute – low byte
Byte1 30. Plant Exerciser minute – high byte
Byte2 31. Manual re-transfer mode – low byte
32 Byte0 31. Manual re-transfer mode – high byte
Byte1 32. Commit to transfer in TDNE – low byte
Byte2 32. Commit to transfer in TDNE – high byte
33 Byte0 33. Test mode engine start only – low byte
Byte1 33. Test mode engine start only – high byte
Byte2 34. Engine run test time (in minutes) – low byte
34 Byte0 34. Engine run test time (in minutes) – high byte
Byte1 35. Pre-transfer subnetwork time (in seconds) – low byte
Byte2 35. Pre-transfer subnetwork time (in seconds) – high byte
35 Byte0 36. Number of generators – low byte
Byte1 36. Number of generators – high byte
Byte2 37. Three-phase or single-phase monitoring – low byte
36 Byte0 37. Three-phase or single-phase monitoring – high byte
Byte1 38. Subnetwork sequencing timer (in seconds) – low byte
Byte2 38. Subnetwork sequencing timer (in seconds) – high byte
37 Byte0 39. PT Ratio – low byte
Byte1 39. PT Ratio – high byte
Byte2 40. Closed Transition on/off – low byte
38 Byte0 40. Closed Transition on/off – high byte
Byte1 41. Closed Transition phase angle difference – low byte
Comm Ver 1-9: Reserved
Byte2 41. Closed Transition phase angle difference – high byte
Comm Ver 1-9: Reserved
504-24 INCOM System Communications, June 2004
Communications Protocol for the IQ Transfer II
Download Setpoints Description (3 F 9) – Continued
Message Byte Description
39 Byte0 42. Closed Transition frequency difference – low byte
Byte1 42. Closed Transition frequency difference – high byte
Byte2 43. Closed Transition voltage difference – low byte
40 Byte0 43. Closed Transition voltage difference – high byte
Byte1 44. In-Phase Transition on/off – low byte
Byte2 44. In-Phase Transition on/off – high byte
41 Byte0 45. TDEF Timer – low byte (Comm Ver 2-9)
Byte1 45. TDEF Timer – high byte
Comm Version 0: Message 41 Byte0, Byte1 were
the In-Phase Transition phase angle difference setpoint
Comm Version 1: Reserved
Byte2 46. In-Phase Transition frequency difference – low byte
42 Byte0 46. In-Phase Transition frequency difference – high byte
Byte1 47. Maximum synchronization time (in minutes) – low byte
Byte2 47. Maximum synchronization time (in minutes) – high byte
43 Byte0 Checksum (sum of previous 42 messages) – low byte
Byte1 Checksum (sum of previous 42 messages) – high byte
Byte2 Complement of checksum of low byte
Note 1: Please refer to the Setpoints Buffer description in Section 450 for information on the valid ranges for each setpoint value.
Note 2: The IQ Transfer will respond with an ACK message after each setpoint message it receives.
INCOM System Communications, June 2004 504-25
Communications Protocol for the IQ Transfer II
Broadcast Synchronize RTC (D E 3) The format of the Broadcast Synchronize RTC message is as follows:
C/D = 1
INST = D
COMM = 0
ADDRESS = Seconds where:
Bit Definition
B0-B6 Reserved
B7-B11 Contain current seconds (0-31)
SCOMM = 3
Note: It is recommended that the Broadcast Synchronize RTC command be transmitted during the time period from the 15th to the 31st second of the minute.
504-26 INCOM System Communications, June 2004
Communications Protocol for the IQ Transfer II
CHANGE RECORD Revision Date Changes
1.00 6/28/02 Taken from IL 17384 Revision 3.10 (June 2002) Part F; made into separate document for inclusion in Revision 3.20.
INCOM System Communications, June 2004 504-27
Communications Protocol for the IQ Transfer II
504-28 INCOM System Communications, June 2004
This page intentionally left blank.
Communication Protocol for the IQ Transfer
COMMUNICATIONS PROTOCOL – IQ TRANSFER
Fast Status (3 0 0) Division Code = 4
Comm. Software Version = 0
Product ID =20
Status Bits Bit Definition
S7-S6 0 0 On Good Source (See Bits S2 and S5.)
0 1 Generator Start
1 0 Transferred (See Bits S2 and S5.)
1 1 In Alarm
S5 1= Source 2 is connected.
S4 1= Powered on since last Fast Status
S3 1= Unread Time-Stamped Transfer Buffer available
S2 1= Source 1 is connected.
S1 1= Source 2 is available.
S0 1= Source 1 is available.
Supported Commands Reference Section (3 0 0) Fast Status Part A, 5.2.3, this section
(3 0 3) Transmit All Standard Buffers Part A, 5.2.8
(3 0 6) Transmit Load Line-to-Line Voltage Buffer Part A, 5.2.10
(3 C 8) Transmit Flags Buffer Part A, 5.2.19, this section
(3 C 9) Transmit Setpoints Buffer Part A, 5.2.20, this section
(3 C B) Transmit Time-Stamped Transfer Buffer Part A, 5.2.21, this section
(3 C C) Transmit Run Time and Transfer Count Buffer This section
(3 C D) Transmit L-L Voltage and Frequency Buffer This section
(3 D 0) Slave Action Part A, 5.2.23.1, 5.3.7, this section
(3 D 8) Receive Current Date and Time Part A, 5.2.25.1
(3 F 9) Download Setpoints Part A, 5.2.26.2, this section
(D E 3) Broadcast Synchronize RTC Part A, 5.2.27, this section
INCOM System Communications, June 2004 505-1
Communication Protocol for the IQ Transfer
FLAGS Buffer Description (3 C 8)
Message Byte Name Description 1 Byte0 Number of additional data messages = 6
Byte1 Flags1: Reason in alarm
Value Definition 0 Unknown
1 Preferred source became available
2 Over voltage on connected source
3 Under voltage on connected source
4 Over frequency on connected source
5 Under frequency on connected source
6 Exercised Generator
7 Test
8 Manual Re-Transfer
9 Communucations
10 Go to Neutral
11 In Program Mode
12 Option or setpoint error
Byte2 Flags2: Current mode (status)
Value Definition 0 Powerup
1 Connected to Source 1
2 TDES timeout (Source 2)
3 TDNE timeout
4 Neutral timeout
5 Waiting for transfer Source 1 to Source 2
6 Connected to Source 2
7 TDES timeout (Source 1)
8 TDEN timeout
9 Neutral timeout
10 Waiting for transfer Source 2 to Source 1
2 Byte0 Reserved
Byte1 Reserved
Byte2 Reserved
505-2 INCOM System Communications, June 2004
Communication Protocol for the IQ Transfer
FLAGS Buffer Description (3 C 8) – Continued
Message Byte Name Description
3 Byte0 Flags3: Bit Definition
B0 Contact Input 1 – Breaker 1 closed (Source 1 connected)
B1 Contact Input 2 – Breaker 2 closed (Source 2 connected)
B2 Contact Input 3 – Breaker 1 Unavailable
B3 Contact Input 4 – Breaker 2 Unavailable
B4 Contact Input 5 – Bypass TDNE/TDEN timers
B5 Contact Input 6 – Return to Neutral (Ext. lockout)
B6 Reserved – (Contact Input 7 – Manual transfer)
B7 Reserved – (Contact Input 8 – undefined)
Byte1 Flags4: Bit Definition
B0 Reserved (Relay output 1 – Close Source 1 breaker)
B1 Reserved (Relay output 2 – Close Source 2 breaker)
B2 Reserved (Relay output 3 – TDN Source 1 breaker)
B3 Reserved (Relay output 4 – TDN Source 2 breaker)
B4 Relay output 5 – Normal power (source 1) available
B5 Relay output 6 – Emergency power (src 2) available
B6 Relay output 7 – Alarm
B7 DIP Switch 1 – Program Mode Byte2 Flags5: Bit Definition
B0 Relay output 9 – Start generator for source 1
B1 Relay output 10 – Start generator for source 2
B2 Preferred Source (1=Source 1 is preferred)
B3 Preferred Source (1=Source 2 is preferred)
B4 Load Energized (1=energized, 0=not energized)
B5 Mode (1=ATS is in Auto Mode)
B6 Mode (1=ATS is in Test Mode)
B7 Mode (1=ATS is in Program Mode)
INCOM System Communications, June 2004 505-3
Communication Protocol for the IQ Transfer
FLAGS Buffer Description (3 C 8) – Continued
Message Byte Name Description
4 Byte0 Flags6: Bit Definition
B0 Addressable Relay #1 IN1
B1 Addressable Relay #2 IN1
B2 Addressable Relay #3 IN1
B3 Addressable Relay #4 IN1
B4 Addressable Relay #5 IN1
B5 Addressable Relay #6 IN1
B6 Addressable Relay #7 IN1
B7 Addressable Relay #8 IN1
Byte1 Flags7: Bit Definition
B0 Addressable Relay #9 IN1
B1 Addressable Relay #10 IN1
B2 Addressable Relay #11 IN1
B3-B7 Reserved
Byte2 Flags8: Bit Definition
B0 Bypass Timer Transfer Enabled (1=enabled)
B1-B7 Reserved
5 Reserved
6 Reserved
7 Reserved
505-4 INCOM System Communications, June 2004
Communication Protocol for the IQ Transfer
SETPOINTS Buffer Description (3 C 9)
Message Byte Description 1 Byte0 Number of additional data messages = 42
Byte1 Firmware Revision
Byte2 Firmware Version
*** Factory-Set Options *** 2 Byte0 TDES – Time Delay Engine Start 0=disabled 1=enabled
Byte1 TDNE – Time Delay Norm to Emerg. 0=disabled 1=enabled
Byte2 TDEN – Time Delay Emerg. to Norm 0=disabled 1=enabled
3 Byte0 TDEC – Time Delay Engine cooldown 0=disabled 1=enabled
Byte1 Source 2 under frequency monitoring 0=disabled 1=enabled
Byte2 Source 2 over frequency monitoring 0=disabled 1=enabled
4 Byte0 Source 2 over voltage monitoring 0=disabled 1=enabled
Byte1 Source 2 under voltage monitoring 0=disabled 1=enabled
Byte2 Transfer Time Delay Bypass TDEN/TDNE push-button
0=disabled 1=TDEN bypass
2=TDNE bypass 3=TDEN/TDNE (bypass either timer)
5 Byte0 User-Selectable Preferred Source 0=disabled 1=enabled
Byte1 Plant Exerciser 0=disabled 1=enabled
Byte2 Source 1 under frequency monitoring 0=disabled 1=enabled
6 Byte0 Source 1 over frequency monitoring 0=disabled 1=enabled
Byte1 Source 1 over voltage monitoring 0=disabled 1=enabled
Byte2 Type of Operation: 0=Automatic
1=User-Selectable
7 Byte0 TDN Time Delay Neutral 0=disabled 1=enabled
Byte1 TDN Neutral Load Sense Delay:
0=disabled
1=enabled (0-30% of nominal voltage)
Byte2 Pre-Transfer Signal on subnetwork 0=disabled 1=enabled
INCOM System Communications, June 2004 505-5
Communication Protocol for the IQ Transfer
SETPOINTS Buffer Description (3 C 9) – Continued
Message Byte Description
8 Byte0 Remote sequencing on subnetwork 0=disabled 1=enabled
Byte1 Service Entrance
0=disabled – Don’t recognize Go-to-neutral input
1=enabled – Respond to Go-to-neutral (and enable Option 16)
Byte2 Overcurrent Protection 0=disabled 1=enabled
9 Byte0 Type of Switch 0=SPB, 1=Motor driven
Byte1 Reserved
Byte2 Reserved
10 Byte0 Reserved
Byte1 Reserved
Byte2 Reserved
*** User-Programmable Setpoints ***
11 Byte0 TDES Timer – low byte Range: 0-120 seconds
Byte1 TDES Timer – high byte – Used when Option 0 is enabled.
Byte2 TDNE Timer – low byte Range: 0-1,800 seconds
12 Byte0 TDNE Timer – high byte – Used when Option 1 is enabled.
Byte1 TDEN Timer – low byte Range: 0-1,800 seconds
Byte2 TDEN Timer – high byte – Used when Option 2 is enabled.
13 Byte0 TDEC Timer – low byte Range: 0-1,800 seconds
Byte1 TDEC Timer – high byte – Used when Option 3 is enabled.
Byte2 Nominal Frequency – low byte Range: 50 or 60
14 Byte0 Nominal Frequency – high byte
Byte1 Nominal voltage – low byte Range: 120-600 volts
Byte2 Nominal voltage – high byte
505-6 INCOM System Communications, June 2004
Communication Protocol for the IQ Transfer
SETPOINTS Buffer Description (3 C 9) – Continued
Message Byte Description
15 Byte0 Source 1 under voltage dropout level (in volts) – low byte
Byte1 Source 1 under voltage dropout level (in volts) – high byte
Range: 50-90% of nominal voltage (message 14)
Byte2 Source 2 under voltage dropout level (in volts) – low byte
16 Byte0 Source 2 under voltage dropout level (in volts) – high byte
Range: 50-90% of nominal voltage (setpoint 5)
Valid only if Option 7 is enabled.
Byte1 Source 1 under voltage pickup level (in volts) – low byte
Byte2 Source 1 under voltage pickup level (in volts) – high byte
Range: dropout level +2%-100% of nominal voltage.
17 Byte0 Source 2 under voltage pickup level (in volts) – low byte
Byte1 Source 2 under voltage pickup level (in volts) – high byte
Range: dropout level +2%-100% of nominal vltg.
Valid only if Option 7 is enabled.
Byte2 Source 1 over voltage dropout level (in volts) – low byte
18 Byte0 Source 1 over voltage dropout level (in volts) – high byte
Range: 105-120% of nominal voltage.
Valid only if Option 13 is enabled.
Byte1 Source 2 over voltage dropout level (in volts) – low byte
Byte2 Source 2 over voltage dropout level (in volts) – high byte
Range: 105-120% of nominal voltage.
Valid only if Option 6 is enabled.
19 Byte0 Source 1 over voltage pickup level (in volts) – low byte
Byte1 Source 1 over voltage pickup level (in volts) – high byte
Range: drop-out level -2%-90% of nominal voltage.
Valid only if Option 13 is enabled.
Byte2 Source 2 over voltage pickup level (in volts) – low byte
INCOM System Communications, June 2004 505-7
Communication Protocol for the IQ Transfer
SETPOINTS Buffer Description (3 C 9) – Continued
Message Byte Description 20 Byte0 Source 2 over voltage pickup level (in volts) – high byte
Range: dropout level -2%-90% of nominal voltage.
Valid only if Option 6 is enabled.
Byte1 Source 1 under frequency dropout level (hertz x10) – low byte
Byte2 Source 1 under frequency dropout level (hertz x10) – high byte
Range: 90-100% of nominal frequency
Valid only if Option 11 is enabled.
21 Byte0 Source 2 under frequency dropout level (hertz x10) – low byte
Byte1 Source 2 under frequency dropout level (hertz x10) – high byte
Range: 90-100% of nominal frequency
Valid only if Option 4 is enabled.
Byte2 Source 1 under frequency pickup level (hertz x10) – low byte
22 Byte0 Source 1 under frequency pickup level (hertz x10) – high byte
Range: dropout level +2%-110% of nominal frequency
Valid only if Option 11 is enabled.
Byte1 Source 2 under frequency pickup level (hertz x10) – low byte
Byte2 Source 2 under frequency pickup level (hertz x10) – high byte
Range: dropout level +2%-110% of nominal frequency
Valid only if Option 4 is enabled.
23 Byte0 Source 1 over frequency dropout level (hertz x10) – low byte
Byte1 Source 1 over frequency dropout level (hertz x10) – high byte
Range: 100-110% of nominal frequency
Valid only if Option 12 is enabled.
Byte2 Source 2 over frequency dropout level (hertz x10) – low byte
505-8 INCOM System Communications, June 2004
Communication Protocol for the IQ Transfer
SETPOINTS Buffer Description (3 C 9) – Continued
Message Byte Description
24 Byte0 Source 2 over frequency dropout level (hertz x10) – high byte
Range: 100-110% of nominal frequency
Valid only if Option 5 is enabled.
Byte1 Source 1 over frequency pickup level (hertz x10) – low byte
Byte2 Source 1 over frequency pickup level (hertz x10) – high byte
Range: dropout level -2%-90% of nominal frequency
Valid only if Option 12 is enabled.
25 Byte0 Source 2 over frequency pickup level (hertz x10) – low byte
Byte1 Source 2 over frequency pickup level (hertz x10) – high byte
Range: dropout level -2%-90% of nominal frequency
Valid only if Option 5 is enabled.
Byte2 TDN with Load Sensing – low byte 0=no, 1=yes
26 Byte0 TDN with Load Sensing – high byte
Byte1 TDN Time delay neutral timer – low byte Range:
Byte2 TDN Time delay neutral timer – high byte 0-120 seconds
Valid only if Option 15 is enabled and setpoint 22 is zero (no load sensing).
27 Byte0 Load voltage decay threshold (volts) – low byte
Byte1 Load voltage decay threshold (volts) – high byte
Range: 0-30% of nominal voltage
Valid only if Option 16 is enabled and Setpoint 22
is set to 1 (with load sensing).
Byte2 Preferred source selection – low byte
28 Byte0 Preferred source selection – high byte
Range: 0=no preference, 1=source 1, 2=source2
Byte1 Plant Exerciser – low byte Range: 0=not enabled
Byte2 Plant Exerciser – high byte 1=enabled
INCOM System Communications, June 2004 505-9
Communication Protocol for the IQ Transfer
SETPOINTS Buffer Description (3 C 9) – Continued
Message Byte Description
29 Byte0 Plant Exerciser Load Transfer – low byte 0=not enabled
Byte1 Plant Exerciser Load Transfer – high byte 1=enabled
Byte2 Plant Exerciser day of week – low byte
30 Byte0 Plant Exerciser day of week – high byte
Range: 1-7, 1=Sunday, 2=Monday, etc.
Byte1 Plant Exerciser hour of day – low byte
Byte2 Plant Exerciser hour of day – high byte
Range: 0-23 hour
31 Byte0 Plant Exerciser minute – low byte
Byte1 Plant Exerciser minute – high byte
Range: 0-59 minute
Byte2 Manual re-transfer mode – low byte 0=auto
32 Byte0 Manual re-transfer mode – high byte 1=pushbutton return
Byte1 Commit to transfer in TDNE – low byte 0=not committed
Byte2 Commit to transfer in TDNE – high byte 1=committed
Setpoint is valid only if TDNE (Option 1) is enabled
33 Byte0 Test mode engine start only – low byte 0=no load transfer
Byte1 Test mode engine start only – high byte 1=load transfer
2=Disable test
Byte2 Engine run test time (in minutes) – low byte
34 Byte0 Engine run test time (in minutes) – high byte
Range: 0-600 minutes
Byte1 Subnetwork pre-transfer time (in seconds) – low byte
Byte2 Subnetwork pre-transfer time (in seconds) – high byte
Range: 1-120 sec., Valid only if Option 17 is enabled.
35 Byte0 Number of generators – low byte Range: 0-2
Byte1 Number of generators – high byte
Byte2 Three phase or single phase monitoring – low byte
505-10 INCOM System Communications, June 2004
Communication Protocol for the IQ Transfer
SETPOINTS Buffer Description (3 C 9) – Continued
Message Byte Description
36 Byte0 Three phase or single phase monitoring – high byte
Range: 1 or 3
Byte1 Subnetwork sequencing timer (in seconds) – low byte
Byte2 Subnetwork sequencing timer (in seconds) – high byte
Range: 1-120 sec., Valid only if Option 18 is enabled.
37 Reserved
38 Reserved
39 Reserved
40 Reserved
41 Reserved
42 Reserved
43 Byte0 Checksum (sum of previous 42 messages – low byte)
Byte1 Checksum (sum of previous 42 messages – high byte)
Byte2 Complement of checksum low byte
INCOM System Communications, June 2004 505-11
Communication Protocol for the IQ Transfer
TIME STAMPED TRANSFER DATA Buffer Description (3 C B)
Message Byte Description Format 1 Byte0 Number of additional data messages = 5
Byte1 TRANSFER DATA Buffer number
Byte2 Number of Unread Transfer Data buffers
2 Byte0 Reserved
Byte1 Time of transfer – 1/100 second = 0
Byte2 Time of transfer – Hour (0-23 BCD)
3 Byte0 Time of transfer – Minute (0-59 BCD)
Byte1 Time of transfer – Second (0-59 BCD)
Byte2 Time of transfer – Month (1-12 BCD)
4 Byte0 Time of transfer – Day (1-31 BCD)
Byte1 Time of transfer – Year (0-99 BCD)
Byte2 Buffer tpe = 81H (Transfer event)
5 Buffer supported map = 0
6 Byte0 Type of Event
Value Definition
1 Transfer from source 1 to source 2
2 Transfer from source 2 to source 1
3 Failed to transfer
4 Engine start – exerciser mode
Byte1 Cause of Event
Value Definition 0 Unknown
1 Preferred source became available
2 Over voltage on connected source
3 Under voltage on connected source
4 Over frequency on connected source
5 Under frequency on connected source
6 Exercised Generator
7 Test
8 Manual Re-transfer
505-12 INCOM System Communications, June 2004
Communication Protocol for the IQ Transfer
TIME STAMPED TRANSFER DATA Buffer Description (3 C B) – Continued
Message Byte Description 6 Byte1 Cause of Event
Value Definition 9 Communucations
10 Go to Neutral
11 n/a
12 n/a
Byte2 Reserved
INCOM System Communications, June 2004 505-13
Communication Protocol for the IQ Transfer
Available, Connect, Run Time and Transfer Count Buffer Description (3 C C)
Message Byte Description 1 Byte0 Number of additional data messages = 11
Byte1 Reserved
Byte2 Reserved
2 Byte0 Source 1 Available Time – Hour LSB
Byte1 Source 1 Available Time – Hour MSB
Byte2 Source 1 Available Time – Minute
3 Byte0 Source 1 Connect Time – Hour LSB
Byte1 Source 1 Connect Time – Hour MSB
Byte2 Source 1 Connect Time – Minute
4 Byte0 Source 1 Run Time – Hour LSB
Byte1 Source 1 Run Time – Hour MSB
Byte2 Source 1 Run Time – Minute
5 Byte0 Source 2 Available Time – Hour LSB
Byte1 Source 2 Available Time – Hour MSB
Byte2 Source 2 Available Time – Minute
6 Byte0 Source 2 Connect Time – Hour LSB
Byte1 Source 2 Connect Time – Hour MSB
Byte2 Source 2 Connect Time – Minute
7 Byte0 Source 2 Run Time – Hour LSB
Byte1 Source 2 Run Time – Hour MSB
Byte2 Source 2 Run Time – Minute
8 Byte0 Number of Transfers (full cycle) – LSB
Byte1 Number of Transfers (full cycle) – MSB
Byte2 Reserved
505-14 INCOM System Communications, June 2004
Communication Protocol for the IQ Transfer
Available, Connect, Run Time and Transfer Count Buffer Description (3 C C) – Continued
Message Byte Description
9 Byte0 Load Energized Time – Hour LSB
Byte1 Load Energized Time – Hour MSB
Byte2 Load Energized Time – Minute
10 Reserved
11 Reserved
12 Reserved
Note: Runtime values roll over to zero after reaching the value of 9,999 hours. The number of transfers value rolls over to zero after reaching the value of 9,999 transfers.
INCOM System Communications, June 2004 505-15
Communication Protocol for the IQ Transfer
Line-to-Line Voltages and Frequency Command Description (3 C D)
Message Byte Description Format 1 Byte0 Number of additional data messages = 10
Byte1 Reserved
Byte2 Reserved
2 Source 1 phase A-B Voltage IMPACC 24-Bit Floating Point
3 Source 1 phase B-C Voltage IMPACC 24-Bit Floating Point
4 Source 1 phase C-A Voltage IMPACC 24-Bit Floating Point
5 Source 1 frequency (hertz) IMPACC 24-Bit Floating Point
6 Source 2 phase A-B Voltage IMPACC 24-Bit Floating Point
7 Source 2 phase B-C Voltage IMPACC 24-Bit Floating Point
8 Source 2 phase C-A Voltage IMPACC 24-Bit Floating Point
9 Source 2 frequency (hertz) IMPACC 24-Bit Floating Point
505-16 INCOM System Communications, June 2004
Communication Protocol for the IQ Transfer
SLAVE ACTION Description (3 D 0)
Byte2 Byte1 Byte0 Definition 0 0 20h Reset Time-Stamped Transfer Data Buffer
0 1 2 Reset Operations Count
0 3 1 Reset Source 1 Available Time
0 3 2 Reset Source 1 Connect Time
0 3 3 Reset Source 1 Runtime
0 3 4 Reset Source 2 Available Time
0 3 5 Reset Source 2 Connect Time
0 3 6 Reset Source 2 Runtime
0 3 7 Reset Load Energized Time
0 3 8 Reset Transfer Status
3 0 0 Advance to the Next Time-Stamped Transfer Buffer
5 0 1 Initiate ATS Test
5 0 2 Bypass TDNE/TDEN (if Option 8 is enabled)
5 0 4 Manual Re-Transfer
INCOM System Communications, June 2004 505-17
Communication Protocol for the IQ Transfer
Download Setpoints Description (3 F 9)
Message Byte Description 1 Byte0 Number of additional data messages = 42
Byte1 Reserved
Byte2 Reserved
2 Reserved
3 Reserved
4 Reserved
5 Reserved
6 Reserved
7 Reserved
8 Reserved
9 Reserved
10 Reserved
11 Byte0 TDES Timer – low byte
Byte1 TDES Timer – high byte
Byte2 TDNE Timer – low byte
12 Byte0 TDNE Timer – high byte
Byte1 TDEN Timer – low byte
Byte2 TDEN Timer – high byte
13 Byte0 TDEC Timer – low byte
Byte1 TDEC Timer – high byte
Byte2 Nominal Frequency – low byte
14 Byte0 Nominal Frequency – high byte
Byte1 Nominal voltage – low byte
Byte2 Nominal voltage – high byte
15 Byte0 Source 1 under voltage dropout level (in volts) – low byte
Byte1 Source 1 under voltage dropout level (in volts) – high byte
Byte2 Source 2 under voltage dropout level (in volts) – low byte
505-18 INCOM System Communications, June 2004
Communication Protocol for the IQ Transfer
Download Setpoints Description (3 F 9) – Continued
Message Byte Description
16 Byte0 Source 2 under voltage dropout level (in volts) – high byte
Byte1 Source 1 under voltage pickup level (in volts) – low byte
Byte2 Source 1 under voltage pickup level (in volts) – high byte
17 Byte0 Source 2 under voltage pickup level (in volts) – low byte
Byte1 Source 2 under voltage pickup level (in volts) – high byte
Byte2 Source 1 over voltage dropout level (in volts) – low byte
18 Byte0 Source 1 over voltage dropout level (in volts) – high byte
Byte1 Source 2 over voltage dropout level (in volts) – low byte
Byte2 Source 2 over voltage dropout level (in volts) – high byte
19 Byte0 Source 1 over voltage pickup level (in volts) – low byte
Byte1 Source 1 over voltage pickup level (in volts) – high byte
Byte2 Source 2 over voltage pickup level (in volts) – low byte
20 Byte0 Source 2 over voltage pickup level (in volts) – high byte
Byte1 Source 1 under frequency dropout level (hertz x10) – low byte
Byte2 Source 1 under frequency dropout level (hertz x10) – high byte
21 Byte0 Source 2 under frequency dropout level (hertz x10) – low byte
Byte1 Source 2 under frequency dropout level (hertz x10) – high byte
Byte2 Source 1 under frequency pickup level (hertz x10) – low byte
22 Byte0 Source 1 under frequency pickup level (hertz x10) – high byte
Byte1 Source 2 under frequency pickup level (hertz x10) – low byte
Byte2 Source 2 under frequency pickup level (hertz x10) – high byte
23 Byte0 Source 1 over frequency dropout level (hertz x10) – low byte
Byte1 Source 1 over frequency dropout level (hertz x10) – high byte
Byte2 Source 2 over frequency dropout level (hertz x10) – low byte
INCOM System Communications, June 2004 505-19
Communication Protocol for the IQ Transfer
Download Setpoints Description (3 F 9) – Continued
Message Byte Description
24 Byte0 Source 2 over frequency dropout level (hertz x10) – high byte
Byte1 Source 1 over frequency pickup level (hertz x10) – low byte
Byte2 Source 1 over frequency pickup level (hertz x10) – high byte
25 Byte0 Source 2 over frequency pickup level (hertz x10) – low byte
Byte1 Source 2 over frequency pickup level (hertz x10) – high byte
Byte2 TDN with Load Sensing – low byte
26 Byte0 TDN with Load Sensing – high byte
Byte1 TDN Time delay neutral timer – low byte
Byte2 TDN Time delay neutral timer – high byte
27 Byte0 Load voltage decay threshold (volts) – low byte
Byte1 Load voltage decay threshold (volts) – high byte
Byte2 Preferred source selection – low byte
28 Byte0 Preferred source selection – high byte
Byte1 Plant Exerciser – low byte
Byte2 Plant Exerciser – high byte
29 Byte0 Plant Exerciser Load Transfer – low byte
Byte1 Plant Exerciser Load Transfer – high byte
Byte2 Plant Exerciser day of week – low byte
30 Byte0 Plant Exerciser day of week – high byte
Byte1 Plant Exerciser hour of day – low byte
Byte2 Plant Exerciser hour of day – high byte
31 Byte0 Plant Exerciser minute – low byte
Byte1 Plant Exerciser minute – high byte
Byte2 Manual re-transfer mode – low byte
505-20 INCOM System Communications, June 2004
Communication Protocol for the IQ Transfer
Download Setpoints Description (3 F 9) – Continued
Message Byte Description
32 Byte0 Manual re-transfer mode – high byte
Byte1 Commit to transfer in TDNE – low byte
Byte2 Commit to transfer in TDNE – high byte
33 Byte0 Test mode engine start only – low byte
Byte1 Test mode engine start only – high byte
Byte2 Engine run test time (in minutes) – low byte
34 Byte0 Engine run test time (in minutes) – high byte
Byte1 Pre-transfer subnetwork time (in seconds) – low byte
Byte2 Pre-transfer subnetwork time (in seconds) – high byte
35 Byte0 Number of generators – low byte
Byte1 Number of generators – high byte
Byte2 Three-phase or single-phase monitoring – low byte
36 Byte0 Three-phase or single-phase monitoring – high byte
Byte1 Subnetwork sequencing timer (in seconds) – low byte
Byte2 Subnetwork sequencing timer (in seconds) – high byte
37 Reserved
38 Reserved
39 Reserved
40 Reserved
41 Reserved
42 Reserved
43 Byte0 Checksum (sum of previous 42 messages – low byte)
Byte1 Checksum (sum of previous 42 messages – high byte)
Byte2 Complement of checksum of low byte
Note 1: Please refer to the Setpoints Buffer Description on in Section 451 for information on the valid ranges for each setpoint value.
Note 2: The IQ Transfer will respond with an ACK message after each setpoint message it receives.
INCOM System Communications, June 2004 505-21
Communication Protocol for the IQ Transfer
Broadcast Synchronize RTC (D E 3) The format of the Broadcast Synchronize RTC message is as follows:
C/D = 1
INST = D
COMM = 0
ADDRESS = Seconds where:
Bit Definition B0-B6 Reserved
B7-B11 contain current seconds (0-31)
SCOMM = 3
Note: It is recommended that the Broadcast Synchroni ze RTC command be transmitted during the time period from the 15th to the 31st second of the minute.
505-22 INCOM System Communications, June 2004
Communication Protocol for the IQ Transfer
Resolution and Range of Standard Buffers Data
Command Value Resolution Range (3 0 6) Volts 1 0 - 396,000
Hertz 0.1 0 - 80.0 (3 C A)
Volts 1 0 - 396,000
Volts 1 0 - 396,000 (3 C D)
Hertz 0.1 0 - 80.0
INCOM System Communications, June 2004 505-23
Communication Protocol for the IQ Transfer
505-24 INCOM System Communications, June 2004
CHANGE RECORD Revision Date Changes
1.00 6/28/02 Taken from IL 17384 Revision 3.10 (June 2002) Part F; made into separate document for inclusion in Revision 3.20.
Communications Protocol for the ATC-400
COMMUNICATIONS PROTOCOL – ATC-400
Fast Status (3 0 0) Division Code = 4
Comm. Software Version = 0 Initial version
= 1 Time-Stamped Transfer Buffer fixed
Product ID: 22
Status Bits: Bit Definition S7-S6 0 0 On Good Source (See Bits S2, S5.)
0 1 Generator Start
1 0 Transferred (See Bits S2, S5.)
1 1 In Alarm
S5 1= Source 2 is connected
S4 1= Powered on since last Fast Status
S3 1= Unread Time-Stamped Transfer Buffer available
S2 1= Source 1 is connected
S1 1= Source 2 is available
S0 1= Source 1 is available
Supported Commands Reference Section (3 0 0) Fast Status Part A, 5.2.3, this section
(3 0 3) Transmit All Standard Buffers Part A, 5.2.8
(3 C 8) Transmit FLAGS Buffer Part A, 5.2.19
(3 C 9) Transmit Setpoints Buffer Part A, 5.2.20, this section
(3 C A) Transmit Synchronization Buffer This section
(3 C B) Transmit Time-Stamped Transfer Buffer Part A, 5.2.21, this section
(3 C C) Transmit Run Time and Transfer Count Buffer This section
(3 C D) Transmit L-L Voltage and Frequency Buffer This section
(3 D 0) Slave Action Part A, 5.2.23.1, 5.3.7, this section
(3 D 8) Receive Current Date and Time Part A, 5.2.25.1
(3 F 9) Download Setpoints Part A, 5.2.26.2, this section
(D E 3) Broadcast Synchronize RTC Part A, 5.2.27, this section
INCOM System Communications, June 2004 506-1
Communication Protocol for the ATC-400
FLAGS Buffer Description (3 C 8)
Message Byte Name Description 1 Byte0 Number of additional data messages = 6
Byte1 Flags1: Reason in alarm
Value Definition 0 Unknown
1 Preferred source became available
2 Over voltage on connected source
3 Under voltage on connected source
4 Over frequency on connected source
5 Under frequency on connected source
6 Plant Exerciser
7 Engine Test
8 Manual Re-Transfer
9 Communications
10-12 n/a
13 Emergency Inhibit
14 Go To Emergency
15 Lockout
16 Sync Fail – phase
17 Sync Fail – freq
18 Monitor Mode
19 Abort
20 Failsafe Event
Byte2 Flags2: Current mode (status)
Value Definition 0 Powerup
1 Connected to Source 1
2 TDES timeout (Source 2)
3 TDNE timeout
4 Neutral timeout
5 Waiting for transfer Source 1 to Source 2
6 Connected to Source 2
7 TDES timeout (Source 1)
8 TDEN timeout
506-2 INCOM System Communications, June 2004
Communications Protocol for the ATC-400
FLAGS Buffer Description (3 C 8) – Continued
Message Byte Name Description 1 Byte1 Flags1: Reason in alarm
9 Neutral timeout
10 Waiting for transfer Source 2 to Source 1
2 Reserved
3 Byte0 Flags3: Bit Definition
B0 Contact Input 1 – Breaker 1 closed (src 1 connected)
B1 Contact Input 2 – Breaker 2 closed (src 2 connected)
B2 Contact Input 3 – Lockout
B3 Contact Input 4 – Go To Emergency
B4 Contact Input 5 –
B5 Contact Input 6 – Monitor Mode
B6 Contact Input 7 – Manual Re-Transfer
B7 Contact Input 8 – Emergency Inhibit
Byte1 Flags4: Bit Definition
B0 Relay output 1 – K1
B1 Relay output 2 – K2
B2 Relay output 3 – K3
B3 Relay output 4 – K4
B4 Relay output 5 – Source 1 available
B5 Relay output 6 – Source 2 available
B6 Relay output 7 – Alarm
B7 Program Switch – Program Mode
Byte2 Flags5: Bit Definition
B0 Reserved
B1 Relay Output 10 – Start Generator
B2 Reserved
B3 Reserved
B4 Load Energized (1=energized, 0=not energized)
B5 Mode (1=ATS is in Auto mode)
B6 Mode (1=ATS is in Test mode)
B7 Mode (1=ATS is in Program mode)
INCOM System Communications, June 2004 506-3
Communication Protocol for the ATC-400
FLAGS Buffer Description (3 C 8) – Continued
Message Byte Name Description
4 Byte0 Flags6: Bit Definition
B0-B7 Reserved
Byte1 Flags7: Bit Definition
B0-B7 Reserved
Byte2 Flags8: Bit Definition
B0 Bypass Timer Transfer Enabled (1=enabled)
B1-B7 Reserved
5 Reserved
6 Reserved
7 Reserved
506-4 INCOM System Communications, June 2004
Communications Protocol for the ATC-400
SETPOINTS Buffer Description (3 C 9)
Message Byte Description 1 Byte0 Number of additional data messages = 42
Byte1 Firmware Revision
Byte2 Firmware Version
*** Factory-Set Options *** 2 Byte0 0. TDES – Time Delay Engine Start 1=enabled
Byte1 1. TDNE – Time Delay Norm to Emerg. 1=enabled
Byte2 2. TDEN – Time Delay Emerg. to Norm 1=enabled
3 Byte0 3. TDEC – Time Delay Engine Cooldown 1=enabled
Byte1 4. Source 2 under frequency monitoring 1=enabled
Byte2 5. Source 2 over frequency monitoring 0=disabled 1=enabled
4 Byte0 6. Source 2 over voltage monitoring 0=disabled 1=enabled
Byte1 7. Source 2 under voltage monitoring 1=enabled
Byte2 8. Transfer Time Delay Bypass TDEN/TDNE push-button 3=TDEN/TDNE (bypass either timer)
5 Byte0 9. Reserved
Byte1 10. Plant Exerciser 1=enabled
Byte2 11. Source 1 under frequency monitoring 0=disabled 1=enabled
6 Byte0 12. Source 1 over frequency monitoring 0=disabled 1=enabled
Byte1 13. Source 1 over voltage monitoring 0=disabled 1=enabled
Byte2 14. Type of Operation: 0=Automatic
1=User-Selectable
7 Byte0 15. TDN Time Delay Neutral 0=disabled 1=enabled
Byte1 16. Reserved
Byte2 17. Pre-Transfer Signal 0=disabled 1=enabled
8 Byte0 18. Reserved
Byte1 19. Reserved
Byte2 20. Over current Protection 0=disabled 1=enabled
INCOM System Communications, June 2004 506-5
Communication Protocol for the ATC-400
SETPOINTS Buffer Description (3 C 9) – Continued
Message Byte Description
9 Byte0 21. Type of Switch 0=SPB, 1=Motor driven
Byte1 22. User Selectable PT Ratio 0=disabled 1=enabled
Byte2 23. Load Shed from Source 2 0=disabled 1=enabled
10 Byte0 24. Go to Emergency 0=disabled 1=enabled
Byte1 25. Type of Transition
0=open transition only
1=open / in-phase transition
Byte2 Option 26. Reserved
*** User-Programmable Setpoints *** 11 Byte0 0. TDES Timer – low byte Range: 0-120 seconds
Byte1 0. TDES Timer – high byte
Byte2 1. TDNE Timer – low byte Range: 0-1,800 seconds
12 Byte0 1. TDNE Timer – high byte
Byte1 2. TDEN Timer – low byte Range: 0-1,800 seconds
Byte2 2. TDEN Timer – high byte
13 Byte0 3. TDEC Timer – low byte Range: 0-1800 seconds
Byte1 3. TDEC Timer – high byte
Byte2 4. Nominal Frequency – low byte Range: 50 or 60 (hertz x10)
14 Byte0 4. Nominal Frequency – high byte
Byte1 5. Nominal voltage – low byte Range: 110-600 volts @ 50Hz
Byte2 5. Nominal voltage – high byte 120-600 volts @ 60Hz
See Note 1 and Note 2 below.
15 Byte0 6. Source 1 under voltage dropout level (in volts) – low byte
Byte1 6. Source 1 under voltage dropout level (in volts) – high byte
Range: 50-97% of nominal voltage (message 14)
Byte2 7. Source 2 under voltage dropout level (in volts) – low byte
506-6 INCOM System Communications, June 2004
Communications Protocol for the ATC-400
SETPOINTS Buffer Description (3 C 9) – Continued
Message Byte Description
16 Byte0 7. Source 2 under voltage dropout level (in volts) – high byte
Range: 50-97% of nominal voltage (setpoint 5)
Byte1 8. Source 1 under voltage pickup level (in volts) – low byte
Byte2 8. Source 1 under voltage pickup level (in volts) – high byte
Range: dropout level+2% - 99% of nominal voltage.
17 Byte0 9. Source 2 under voltage pickup level (in volts) – low byte
Byte1 9. Source 2 under voltage pickup level (in volts) – high byte
Range: dropout level+2% - 99% of nominal voltage.
Byte2 10. Source 1 over voltage dropout level (in volts) – low byte
18 Byte0 10. Source 1 over voltage dropout level (in volts) – high byte
Range: 105 - 120% of nominal voltage.
Valid only if option 13 is enabled.
Byte1 11. Source 2 over voltage dropout level (in volts) – low byte
Byte2 11. Source 2 over voltage dropout level (in volts) – high byte
Range: 105 - 120% of nominal voltage.
Valid only if Option 6 is enabled.
19 Byte0 12. Source 1 over voltage pickup level (in volts) – low byte
Byte1 12. Source 1 over voltage pickup level (in volts) – high byte
Range: 103% of nominal voltage – dropout level-2%
Valid only if Option 13 is enabled.
Byte2 13. Source 2 over voltage pickup level (in volts) – low byte
Note 1: If the PT Ratio option is enabled, then the system nominal voltage must be either 120 VAC for a system frequency of 60Hz, or 110 VAC if the system frequency is 50Hz. The system voltage cannot be changed from either 120 VAC or 110 VAC.
Note 2: If the PT Ratio option is enabled, when the system nominal frequency is changed, the nominal system voltage must change and with it the voltage dropout and pickup values must also change to the default values.
INCOM System Communications, June 2004 506-7
Communication Protocol for the ATC-400
SETPOINTS Buffer Description (3 C 9) – Continued
Message Byte Description
20 Byte0 13. Source 2 over voltage pickup level (in volts) – high byte
Range: 103% of nominal voltage – dropout level-2%
Valid only if Option 6 is enabled.
Byte1 14. Source 1 under frequency dropout level (hertz x10) – low byte
Byte2 14. Source 1 under frequency dropout level (hertz x10) – high byte
Range: 90-97% of nominal frequency
Valid only if Option 11 is enabled.
21 Byte0 15. Source 2 under frequency dropout level (hertz x10) – low byte
Byte1 15. Source 2 under frequency dropout level (hertz x10) – high byte
Range: 90-97% of nominal frequency
Byte2 16. Source 1 under frequency pickup level (hertz x10) – low byte
22 Byte0 16. Source 1 under frequency pickup level (hertz x10) – high byte
Range: dropout level+1Hz - 99% of nominal frequency
Valid only if Option 11 is enabled.
Byte1 17. Source 2 under frequency pickup level (hertz x10) – low byte
Byte2 17. Source 2 under frequency pickup level (hertz x10) – high byte
Range: drop-out level+1Hz - 99% of nominal frequency
23 Byte0 18. Source 1 over frequency dropout level (hertz x10) – low byte
Byte1 18. Source 1 over frequency dropout level (hertz x10) – high byte
Range: 103-110% of nominal frequency
Valid only if Option 12 is enabled.
Byte2 19. Source 2 over frequency dropout level (hertz x10) – low byte
506-8 INCOM System Communications, June 2004
Communications Protocol for the ATC-400
SETPOINTS Buffer Description (3 C 9) – Continued
Message Byte Description
24 Byte0 19. Source 2 over frequency dropout level (hertz x10) – high byte
Range: 103-110% of nominal frequency
Valid only if Option 5 is enabled.
Byte1 20. Source 1 over frequency pickup level (hertz x10) – low byte
Byte2 20. Source 1 over frequency pickup level (hertz x10) – high byte
Range: 101% of nominal frequency – dropout level-1Hz
Valid only if Option 12 is enabled.
25 Byte0 21. Source 2 over frequency pickup level (hertz x10) – low byte
Byte1 21. Source 2 over frequency pickup level (hertz x10) – high byte
Range: 101% of nominal frequency – dropout level-1Hz
valid only if Option 5 is enabled.
Byte2 22. Reserved
26 Byte0 22. Reserved
Byte1 23. TDN Time delay neutral timer – low byte Range:
Byte2 23. TDN Time delay neutral timer – high byte 0-120 seconds
Valid only if Option 15 is enabled.
27 Byte0 24. Reserved
Byte1 24. Reserved
Byte2 25. Reserved
28 Byte0 25. Reserved
Byte1 26. Plant Exerciser – low byte
Range: Value Definition
0 Not enabled
1 Daily
2 7-day
3 14-day
4 28-day
Byte2 26. Plant Exerciser – high byte
INCOM System Communications, June 2004 506-9
Communication Protocol for the ATC-400
SETPOINTS Buffer Description (3 C 9) – Continued
Message Byte Description
29 Byte0 27. Plant Exerciser Load Transfer – low byte 0=not enabled
Byte1 27. Plant Exerciser Load Transfer – high byte 1=enabled
Byte2 28. Plant Exerciser day of week – low byte
30 Byte0 28. Plant Exerciser day of week – high byte
Range: Value Definition
1-7 For setpoint 26 = 2
1-14 For setpoint 26 = 3
1-28 For setpoint 26 = 4
(1=Sunday, 2=Monday, etc.)
Byte1 29. Plant Exerciser hour of day – low byte
Byte2 29. Plant Exerciser hour of day – high byte
Range: 0-23 hour
31 Byte0 30. Plant Exerciser minute – low byte
Byte1 30. Plant Exerciser minute – high byte
Range: 0-59 minute
Byte2 31. Manual re-transfer mode – low byte 0=auto
32 Byte0 31. Manual re-transfer mode – high byte 1=pushbutton return
Byte1 32. Commit to transfer in TDNE – low byte 0=not committed
Byte2 32. Commit to transfer in TDNE – high byte 1=committed
33 Byte0 33. Test mode engine start only – low byte 0=no load transfer
Byte1 33. Test mode engine start only – high byte 1=load transfer
2=Disable test
Byte2 34. Engine run test time (in minutes) – low byte
34 Byte0 34. Engine run test time (in minutes) – high byte
Range: 0-600 minutes
Byte1 35. Pre-transfer time (in seconds) – low byte
Byte2 35. Pre-transfer time (in seconds) – high byte
Range: 1-120 sec., Valid only if Option 17 is enabled.
506-10 INCOM System Communications, June 2004
Communications Protocol for the ATC-400
SETPOINTS Buffer Description (3 C 9) – Continued
Message Byte Description
35 Byte0 36. Number of generators – low byte Range: 0-1
Byte1 36. Number of generators – high byte
Byte2 37. Three-phase or single-phase monitoring – low byte
36 Byte0 37. Three-phase or single-phase monitoring – high byte
Range: 1 or 3
Byte1 38. Reserved
Byte2 38. Reserved
37 Byte0 39. PT Ratio – low byte Read Only; Range: 2 through 500:1
Byte1 39. PT Ratio – high byte Valid only if option 22 is enabled
Byte2 40. TDEF Time Delay Emerg Fail timer – low byte
38 Byte0 40. TDEF Time Delay Emerg Fail timer – high byte
Range: 0-6 seconds
Byte1 41. In-phase Transition on/off – low byte
Byte2 41. In-phase Transition on/off – high byte
Valid only if Option 25 is set to 1.
39 Byte0 42. In-phase Transition frequency difference – low byte
Byte1 42. In-phase Transition frequency difference – high byte
Range: 0.0 - 3.0 Hz. Valid only if Option 25 is set to
1 and Setpoint 41 is set to 1 (enabled).
Byte2 43. Maximum synchronization time (in minutes) – low byte
40 Byte0 43. Maximum synchronization time (in minutes) – high byte
Range: 1-60 minutes. Valid only if Option 25 is set to
1 and Setpoint 41 is set to 1.
Byte1 44. Reserved
Byte2 44. Reserved
41 Byte0 45. Reserved
Byte1 45. Reserved
Byte2 46. Reserved
INCOM System Communications, June 2004 506-11
Communication Protocol for the ATC-400
SETPOINTS Buffer Description (3 C 9) – Continued
Message Byte Description
42 Byte0 46. Reserved
Byte1 47. Reserved
Byte2 47. Reserved
43 Byte0 Checksum (sum of previous 42 messages) – low byte
Byte1 Checksum (sum of previous 42 messages) – high byte
Byte2 Complement of checksum low byte
506-12 INCOM System Communications, June 2004
Communications Protocol for the ATC-400
Synchronization Buffer Description (3 C A) – Comm Version > 0
Message Byte Description Format 1 Byte0 Number of additional data messages = 7
Byte1 Reserved
Byte2 Reserved
2 Reserved
3 Frequency difference IMPACC 24-Bit Floating Point
4 Reserved
5 Byte0 Reserved
Byte1 Reserved
Byte2 Reserved
6 Reserved
7 Reserved
8 Reserved
INCOM System Communications, June 2004 506-13
Communication Protocol for the ATC-400
TIME-STAMPED TRANSFER DATA Buffer Description (3 C B)
Message Byte Description Format 1 Byte0 Number of additional data messages = 5
Byte1 TRANSFER DATA Buffer number
Byte2 Number of Unread Transfer Data buffers
2 Byte0 Reserved
Byte1 Time of transfer – 1/100 second = 0
Byte2 Time of transfer – Hour (0-23 BCD)
3 Byte0 Time of transfer – Minute (0-59 BCD)
Byte1 Time of transfer – Second (0-59 BCD)
Byte2 Time of transfer – Month (1-12 BCD)
4 Byte0 Time of transfer – Day (1-31 BCD)
Byte1 Time of transfer – Year (0-99 BCD)
Byte2 Buffer type = 81H (Transfer event)
5 Buffer supported map = 0
506-14 INCOM System Communications, June 2004
Communications Protocol for the ATC-400
TIME-STAMPED TRANSFER DATA Buffer Description (3 C B) – Continued
Message Byte Description 6 Byte0 Type of Event
Value Definition
1 Transfer from source 1 to source 2
2 Transfer from source 2 to source 1
3 Failed to transfer
4 Engine start – exerciser mode
Byte1 Cause of Event
Value Definition 0 Unknown
1 Preferred source became available
2 Over voltage on connected source
3 Under voltage on connected source
4 Over frequency on connected source
5 Under frequency on connected source
6 Plant Exerciser
7 EngineTest
8 Manual Re-Transfer
9 Communications
10 n/a
11 n/a
12 n/a
13 Emergency Inhibit
14 Go To Emergency
15 Lockout
16 Sync Fail – phase
17 Sync Fail – freq
18 Monitor Mode
19 Abort
20 Failsafe event
Byte2 Reserved
INCOM System Communications, June 2004 506-15
Communication Protocol for the ATC-400
Available, Connect, Run Time, and Transfer Count Buffer Description (3 C C)
Message Byte Description 1 Byte0 Number of additional data messages = 11
Byte1 Reserved
Byte2 Reserved
2 Byte0 Source 1 Available Time – Hour LSB
Byte1 Source 1 Available Time – Hour MSB
Byte2 Source 1 Available Time – Minute
3 Byte0 Source 1 Connect Time – Hour LSB
Byte1 Source 1 Connect Time – Hour MSB
Byte2 Source 1 Connect Time – Minute
4 Byte0 Reserved
Byte1 Reserved
Byte2 Reserved
5 Byte0 Source 2 Available Time – Hour LSB
Byte1 Source 2 Available Time – Hour MSB
Byte2 Source 2 Available Time – Minute
6 Byte0 Source 2 Connect Time – Hour LSB
Byte1 Source 2 Connect Time – Hour MSB
Byte2 Source 2 Connect Time – Minute
7 Byte0 Source 2 Run Time – Hour LSB
Byte1 Source 2 Run Time – Hour MSB
Byte2 Source 2 Run Time – Minute
8 Byte0 Number of Transfers (full cycle) – LSB
Byte1 Number of Transfers (full cycle) – MSB
Byte2 Reserved
506-16 INCOM System Communications, June 2004
Communications Protocol for the ATC-400
Available, Connect, Run Time, and Transfer Count Buffer Description (3 C C) – Continued
Message Byte Description
9 Byte0 Load Energized Time – Hour LSB
Byte1 Load Energized Time – Hour MSB
Byte2 Load Energized Time – Minute
10 Reserved
11 Reserved
12 Reserved
Note: Runtime values roll over to zero after reaching the value of 9,999 hours. The number of transfers value rolls over to zero after reaching the value of 9,999 transfers.
INCOM System Communications, June 2004 506-17
Communication Protocol for the ATC-400
Line-to-Line Voltages and Frequency Command Description (3 C D)
Message Byte Description Format 1 Byte0 Number of additional data messages = 8
Byte1 Reserved
Byte2 Reserved
2 Source 1 phase A-B Voltage IMPACC 24-Bit Floating Point
3 Source 1 phase B-C Voltage IMPACC 24-Bit Floating Point
4 Source 1 phase C-A Voltage IMPACC 24-Bit Floating Point
5 Source 1 frequency (hertz) IMPACC 24-Bit Floating Point
6 Source 2 phase A-B Voltage IMPACC 24-Bit Floating Point
7 Source 2 phase B-C Voltage IMPACC 24-Bit Floating Point
8 Source 2 phase C-A Voltage IMPACC 24-Bit Floating Point
9 Source 2 frequency (hertz) IMPACC 24-Bit Floating Point
506-18 INCOM System Communications, June 2004
Communications Protocol for the ATC-400
SLAVE ACTION Description (3 D 0)
Byte2 Byte1 Byte0 Definition 0 0 20h Reset Time-Stamped Transfer Data Buffer
0 1 2 Reset Operations Count
0 3 1 Reset Source 1 Available Time
0 3 2 Reset Source 1 Connect Time
0 3 4 Reset Source 2 Available Time
0 3 5 Reset Source 2 Connect Time
0 3 6 Reset Source 2 Runtime
0 3 7 Reset Load Energized Time
0 3 8 Reset Transfer Status
3 0 0 Advance to the Next Time-Stamped Transfer Buffer
5 0 1 Initiate ATS Test
5 0 2 Bypass TDNE/TDEN
5 0 4 Manual Re-Transfer
5 0 5 Cancel ATS Test
5 0 6 Go To Emergency
5 0 7 Cancel Go To Emergency
INCOM System Communications, June 2004 506-19
Communication Protocol for the ATC-400
Download Setpoints Description (3 F 9)
Message Byte Description 1 Byte0 Number of additional data messages = 42
Byte1 Reserved
Byte2 Reserved
2 Reserved
3 Reserved
4 Reserved
5 Reserved
6 Reserved
7 Reserved
8 Reserved
9 Reserved
10 Reserved
11 Byte0 0. TDES Timer – low byte
Byte1 0. TDES Timer – high byte
Byte2 1. TDNE Timer – low byte
12 Byte0 1. TDNE Timer – high byte
Byte1 2. TDEN Timer – low byte
Byte2 2. TDEN Timer – high byte
13 Byte0 3. TDEC Timer – low byte
Byte1 3. TDEC Timer – high byte
Byte2 4. Nominal Frequency – low byte
14 Byte0 4. Nominal Frequency – high byte
Byte1 5. Nominal voltage – low byte
Byte2 5. Nominal voltage – high byte
15 Byte0 6. Source 1 undervoltage dropout level (in volts) – low byte
Byte1 6. Source 1 undervoltage dropout level (in volts) – high byte
Byte2 7. Source 2 undervoltage dropout level (in volts) – low byte
506-20 INCOM System Communications, June 2004
Communications Protocol for the ATC-400
Download Setpoints Description (3 F 9) – Continued
Message Byte Description 16 Byte0 7. Source 2 under voltage dropout level (in volts) – high byte
Byte1 8. Source 1 under voltage pickup level (in volts) – low byte
Byte2 8. Source 1 under voltage pickup level (in volts) – high byte
17 Byte0 9. Source 2 under voltage pickup level (in volts) – low byte
Byte1 9. Source 2 under voltage pickup level (in volts) – high byte
Byte2 10. Source 1 over voltage dropout level (in volts) – low byte
18 Byte0 10. Source 1 over voltage dropout level (in volts) – high byte
Byte1 11. Source 2 over voltage dropout level (in volts) – low byte
Byte2 11. Source 2 over voltage dropout level (in volts) – high byte
19 Byte0 12. Source 1 over voltage pickup level (in volts) – low byte
Byte1 12. Source 1 over voltage pickup level (in volts) – high byte
Byte2 13. Source 2 over voltage pickup level (in volts) – low byte
20 Byte0 13. Source 2 over voltage pickup level (in volts) – high byte
Byte1 14. Source 1 under frequency dropout level (hertz x10) – low byte
Byte2 14. Source 1 under frequency dropout level (hertz x10) – high byte
21 Byte0 15. Source 2 under frequency dropout level (hertz x10) – low byte
Byte1 15. Source 2 under frequency dropout level (hertz x10) – high byte
Byte2 16. Source 1 under frequency pickup level (hertz x10) – low byte
22 Byte0 16. Source 1 under frequency pickup level (hertz x10) – high byte
Byte1 17. Source 2 under frequency pickup level (hertz x10) – low byte
Byte2 17. Source 2 under frequency pickup level (hertz x10) – high byte
INCOM System Communications, June 2004 506-21
Communication Protocol for the ATC-400
Download Setpoints Description (3 F 9) – Continued
Message Byte Description
23 Byte0 18. Source 1 over frequency dropout level (hertz x10) – low byte
Byte1 18. Source 1 over frequency dropout level (hertz x10) – high byte
Byte2 19. Source 2 over frequency dropout level (hertz x10) – low byte
24 Byte0 19. Source 2 over frequency dropout level (hertz x10) – high byte
Byte1 20. Source 1 over frequency pickup level (hertz x10) – low byte
Byte2 20. Source 1 over frequency pickup level (hertz x10) – high byte
25 Byte0 21. Source 2 over frequency pickup level (hertz x10) – low byte
Byte1 21. Source 2 over frequency pickup level (hertz x10) – high byte
Byte2 22. Reserved
26 Byte0 22. Reserved
Byte1 23. TDN Time delay neutral timer – low byte
Byte2 23. TDN Time delay neutral timer – high byte
27 Byte0 24. Reserved
Byte1 24. Reserved
Byte2 25. Reserved
28 Byte0 25. Reserved
Byte1 26. Plant Exerciser – low byte
Byte2 26. Plant Exerciser – high byte
29 Byte0 27. Plant Exerciser Load Transfer – low byte
Byte1 27. Plant Exerciser Load Transfer – high byte
Byte2 28. Plant Exerciser day of week – low byte
506-22 INCOM System Communications, June 2004
Communications Protocol for the ATC-400
Download Setpoints Description (3 F 9) – Continued
Message Byte Description
30 Byte0 28. Plant Exerciser day of week – high byte
Byte1 29. Plant Exerciser hour of day – low byte
Byte2 29. Plant Exerciser hour of day – high byte
31 Byte0 30. Plant Exerciser minute – low byte
Byte1 30. Plant Exerciser minute – high byte
Byte2 31. Manual re-transfer mode – low byte
32 Byte0 31. Manual re-transfer mode – high byte
Byte1 32. Commit to transfer in TDNE – low byte
Byte2 32. Commit to transfer in TDNE – high byte
33 Byte0 33. Test mode engine start only – low byte
Byte1 33. Test mode engine start only – high byte
Byte2 34. Engine run test time (in minutes) – low byte
34 Byte0 34. Engine run test time (in minutes) – high byte
Byte1 35. Pre-transfer subnetwork time (in seconds) – low byte
Byte2 35. Pre-transfer subnetwork time (in seconds) – high byte
35 Byte0 36. Number of generators – low byte
Byte1 36. Number of generators – high byte
Byte2 37. Three phase or single phase monitoring – low byte
36 Byte0 37. Three phase or single phase monitoring – high byte
Byte1 38. Reserved
Byte2 38. Reserved
37 Byte0 39. PT Ratio – low byte
Byte1 39. PT Ratio – high byte
Byte2 40. TDEF Time Delay Emerg Fail timer – low byte
INCOM System Communications, June 2004 506-23
Communication Protocol for the ATC-400
Download Setpoints Description (3 F 9) – Continued
Message Byte Description
38 Byte0 40. TDEF Time Delay Emerg Fail timer – high byte
Byte1 41. In-phase Transition on/off – low byte
Byte2 41. In-phase Transition on/off – high byte
39 Byte0 42. In-phase Transition frequency difference – low byte
Byte1 42. In-phase Transition frequency difference – high byte
Byte2 43. Maximum synchronization time (in minutes) – low byte
40 Byte0 43. Maximum synchronization time (in minutes) – high byte
Byte1 44. Reserved
Byte2 44. Reserved
41 Byte0 45. Reserved
Byte1 45. Reserved
Byte2 46. Reserved
42 Byte0 46. Reserved
Byte1 47. Reserved
Byte2 47. Reserved
43 Byte0 Checksum (sum of previous 42 messages) – low byte
Byte1 Checksum (sum of previous 42 messages) – high byte
Byte2 Complement of checksum low byte
Note 1: Refer to the Setpoints Buffer description in this section for information on the valid ranges for each setpoint value.
Note 2: The IQ Transfer responds with an ACK message after each setpoint message it receives.
506-24 INCOM System Communications, June 2004
Communications Protocol for the ATC-400
Broadcast Synchronize RTC (D E 3) The format of the Broadcast Synchronize RTC message is as follows:
C/D = 1
INST = D
COMM = E
ADDRESS = Seconds where:
Bit Definition
B0-B6 Reserved
B7-B11 Contain current seconds (0-31)
SCOMM = 3
Note: It is recommended that the Broadcast Synchronize RTC command be transmitted during the time period from the 15th to the 31st second of the minute.
INCOM System Communications, June 2004 506-25
Communication Protocol for the ATC-400
Resolution and Range of Standard Buffers Data
Command Value Resolution Range (3 C A) Hertz 0.1 0 - 80.0
Volts 1 0 - 396,000 (3 C D)
Hertz 0.1 0 - 80.0
506-26 INCOM System Communications, June 2004
Communications Protocol for the ATC-400
CHANGE RECORD Revision Date Changes
1.00 6/28/02 Taken from IL 17384 Revision 3.10 (June 2002) Part F; made into separate document for inclusion in Revision 3.20.
1.02 11/27/02 Updates made to file (bit-level designations) by Bert Popovich.
1.03 1/02/03 Updates made to the file by Bert Popovich per the request of Russ Timco.
INCOM System Communications, June 2004 506-27
Communication Protocol for the ATC-400
506-28 INCOM System Communications, June 2004
This page left intentionally blank.
Communication Protocol for the Digital Input Module (DIM)
COMMUNICATIONS PROTOCOL – DIGITAL INPUT MODULE (DIM)
INCOM Network Transmission The INCOM transmission is packed into a 33-bit INCOM message as shown in Figure 1. The INCOM message packet consists of the following elements:
2 start bits ♦
♦
♦
♦
♦
A single Control/Data Flag bit
24 message body bits
5 BCH check bits
A single stop bit
Figure 1: INCOM Network Packet 32 31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 09
Byte 2 Byte 1 Byte 0 0
08 07 06 05 04 03 02 01 00
1 1 C/DBCH
Control / Data Flag Instruction
Command
Address Sub-commandStop Bit Start Bits
LSBMSB
INCOM Communication INCOM communication to the DIM is a two-way protocol between a master and the DIM (a slave). The network uses a carrier-based, twisted-pair communication protocol. DIMs are always slaves. The network protocol is based on the 33-bit INCOM message packet, shown in Figure 1: INCOM Network Packet (above).
DIM-to-Master Command Set There are two conditions under which the DIM on the INCOM/IMPACC network may send a return message to the master with the Command/Data flag set to “Command.” These conditions are defined in the following sections. In the following messages, the address matches that of the slave device (DIM). Descriptions of these commands appear in this section as well as in Part A of IL 17384 (listed below).
INCOM/IMPACC Slave-to-Master Supported Commands Reference Section
(3 1 0) Acknowledge Part A, 5.1.1
(3 1 1) Negative Acknowledge Part A, 5.1.2
(3 1 5) Product Buffer Not Yet Available Part A, 5.1.3
(3 1 9) Sub-Network Product Not Responding Part A, 5.1.4
(3 1 A) Checksum Error Part A, 5.1.5
(3 1 B) Downloaded Value Out of Range Part A, 5.1.6
(3 1 C) Product Not in a State That Allows the Requested Action Part A, 5.1.7
INCOM System Communications, June 2004 507-1
Communication Protocol for the Digital Input Module (DIM)
Supported Slave-to-Master Commands Acknowledge (3 1 0) Several commands require that the slave device transmit a positive acknowledge message to the IMPACC master. This indicates that the device accepted the last command or the last data transmission was completed successfully.
Negative Acknowledge (3 1 1) The DIM will transmit a negative acknowledge instead of a positive acknowledge under certain error conditions. This reply indicates that the device has not accepted the command and subcommand request. In general, the (3 1 1) response will be generated by the following conditions:
The slave device received a control message that it does not recognize or support. ♦
♦
♦
♦
♦
♦
Control messages received with the instruction field not equal to 3 will not generate a response.
Product Buffer Not Yet Available (3 1 5) The DIM will transmit this message if it receives an incorrect Sequence Number during a (3 F B) command message sequence. [Refer to Save Energy Broadcast Command (D 0 0) on Page 28.]
Subnetwork Product Not Responding (3 1 9) The DIM will transmit this message in response to a (3 D 1)(3 x y) Subnetwork Command that cannot be processed because of a non-existent address.
Checksum Error (3 1 A) The DIM will transmit this message in response to a (3 F 9) Download Setpoints command that cannot be processed due to a checksum error.
Downloaded Value Out Of Range (3 1 B) The DIM will transmit this message under the following conditions:
The downloaded setpoint cannot be processed because it is out of range.
When attempting to enter Test Mode, the response code is incorrect.
Product Not In A State That Allows The Requested Action (3 1 C) The DIM will transmit this message under the following conditions:
When attempting to enter Test Mode, the Test Mode jumper is not installed.
A Clear DIM Counters (3 9 1) command is received when the module is not in Test Mode.
507-2 INCOM System Communications, June 2004
Communication Protocol for the Digital Input Module (DIM)
Master-to-DIM Command Set The following INCOM commands are supported by the DIM. All of these messages are sent with the Control/Data flag set to “Control,” and must have an address match between the IQ Energy Sentry II (16) address and the address field of the received message. Some of these commands are referenced in Part A of IL 17384 in addition to this section. (Refer to the supported commands list that follows.)
For these reasons, only the instruction, command, and subcommand fields are specified in the following sections as follows: (<Instruction> <Command> <Subcommand>).
INCOM/IMPACC Master-to-Slave Supported Commands Reference Section
(3 0 0) Status Part A, 5.2.3
(3 0 1) Extended Status This section
(3 1 F) Transmit Setpoint Descriptions Part A, 5.3.4
(3 8 0) Transmit Supported Command List This section
(3 8 2) Transmit Supported Slave Action List This section
(3 8 4) Transmit Supported (D x x) Broadcast List This section
(3 8 8) Transmit Supported Subnetwork Addresses This section
(3 8 A) Transmit Maximum Response Time This section
(3 8 B) Transmit (3 8 x) Response Length This section
(3 8 C) Transmit ASCII String Length This section
(3 8 E) Transmit Standard ASCII String This section
(3 9 0) Test Command: Enter Factory Test Mode This section
(3 9 1) Test Command: Clear DIM Counters This section
(3 A 4) Transmit INCOM Slave-Interface Statistics Buffer Part A, 5.2.28.2
(3 A 7) Transmit Checksum of Previous Data Buffer Part A, 5.2.28
(3 A 8) Transmit Change Notification Part A, 5.2.28
(3 C 8) Transmit Digital Inputs Part A, 5.2.19
(3 C 9) Transmit Setpoint Structure Part A, 5.2.20
(3 C F) Transmit Setpoints Part A, 5.3.6
(3 D 0) Slave Action Part A, 5.2.23.1, 5.3.7
(3 D 1) Process Subnetwork Command Part A, 5.2.24
(3 F 9) Write Setpoints Block Part A, 5.2.26.2
(3 F B) Open Download Setpoints Session Part A, 5.3.9
(D 0 0) Save Energy Request Broadcast Part A, 5.2.27, 5.3.1.1
Commands sent directly to the DIM’s address [excluding (3 D 1) commands] refer either to configuration, the digital inputs, or system status. Metered data is obtained using the Process Sub-Network Command (3 D 1). Refer to Master-to-DIM Module Meter Command Set on Page 30.
INCOM System Communications, June 2004 507-3
Communication Protocol for the Digital Input Module (DIM)
Status (3 0 0) The DIM responds with a 3-byte data message that has the following format:
BYTE2 | BYTE1 | BYTE0 |
MSB | | LSB |
S7 S6 S5 S4 S3 S2 S1 S0 | P5 P4 P3 P2 P1 P0 V3 V2 | V1 V0 D5 D4 D3 D2 D1 D0 |
where
D5 D4 D3 D2 D1 D0 => Division/class code = 35 (multiple meter).
V3 V2 V1 V0 => Communications Software version 1.
P5 P4 P3 P2 P1 P0 => Product ID = 1.
The remaining bits are defined as follows:
Bit Definition
S7-S6 00 Normal – Inactive (unused)
01 Normal – Active
10 Abnormal – Inactive (unused)
11 Abnormal – Active (Alarm – DIM Module Malfunction)
S5-S2 0 – Reserved
S1 Inactive Detector Flag
S0 (3 A 8) Change Notification
The Abnormal bit (S7) is set when the counter data is invalid. This occurs under the following condition:
Upon initialization, a checksum error is detected when the counter values are retrieved from EEPROM.
♦
The Abnormal bit can only be cleared if the master resets the counters. This may be done at the factory using the (3 9 0) and (3 9 1) test commands.
The (global) Inactive Detector Flag (S1) is set when any of the four channels' counters had been active, but then were inactive for the Inactive Time. The Inactive Time is a setpoint ranging from 15 minutes to 45 days. It has a default value of three days. The Inactive Detector Flag is the logical “OR” of each individual channel’s inactive flag. S1 is cleared when each channel’s inactive flag is clear.
A channel’s flag may be cleared via the (3 D 1)(3 D 0) N=00:04:nn Reset Inactive Flag subnetwork slave action command. Refer to Slave Action Command (3 D 1)(3 D 0) on Page 46.
Note: A channel’s Inactive Dectector Flag will be reset upon initialization. If the counter is never active (as when a channel is not used), the flag will never be set. It is only set if the channel’s counter had been active and then was inactive for the Inactive Time.
The (3 A 8) Change Notification Flag (S0) is set when any bit in the (3 A 8) response changes from a “zero” to a “one.” S0 is cleared when the (3 A 8) command is received by the DIM.
507-4 INCOM System Communications, June 2004
Communication Protocol for the Digital Input Module (DIM)
Extended Status (3 0 1) The DIM responds with two data messages that have the following format.
Message 1 is identical to the response to the (3 0 0) command. ♦
♦ Message 2 is defined per the Plug n’ Play protocol for Primary Status, Secondary Status, and Cause-of-Status. Message 2 format follows:
BYTE2 | BYTE1 | BYTE0 |
MSB | | LSB |
P7 P6 P5 P4 P3 P2 P1 P0 | S4 S3 S2 S1 S0 C10 C9 C8 | C7 C6 C5 C4 C3 C2 C1 C0 |
where
P7 P6 … P0 => Primary Status.
S4 S3 S2 S1 S0 => Secondary Status.
C10 C9 … C0 => Cause of Status.
Valid responses are summarized in Table 1.
Table 1: Valid (3 0 1) Responses
Response Priority
Primary Status
Secondary Status
Cause of Status
Description
1
(highest)
4
(Alarm)
1
(Not Applicable)
40
(Diagnostic Fail) Diagnostic failure
occurred on power-up
2 9 (Running)
8
(Device in Alarm)
2
(External Condition #1) One or more channels
are inactive
3 9 (Running)
1
(Not Applicable)
39
(Diagnostic Warning) Error occurred during
normal operation
4
(lowest) 9
(Running) 1
(Not Applicable)
1
(Normal) Normal operation
A diagnostic warning occurs if the module firmware vectors to an unused interrupt. Normal operation is resumed. The warning is cleared only by the (3 D 0) N=00:00:01 Reset Alarm command. It is not cleared by cycling power.
♦
♦
♦
♦
If one or more channels are inactive, a device is considered to be in alarm. [Refer to the section Status (3 0 0) on Page 4.]
A diagnostic failure occurs if, after a reset, the module firmware detects a checksum error upon retrieval of the counter values. Normal operation continues, but both the checksum error and the error flag are maintained unless cleared by the INCOM master.
The error is cleared only if the master resets the counters. This may be done at the factory using the (3 9 0) and (3 9 1) test commands.
INCOM System Communications, June 2004 507-5
Communication Protocol for the Digital Input Module (DIM)
Transmit Setpoint Group 1 Description (3 1 F) N=01:00:00 When this command is received, the DIM responds with the string table number and index of the ASCII name of the setpoints group, “Inactivity Time.” It also responds with the string table number and index of the ASCII help text, “Duration of counter inactivity that may occur before its associated inactivity flag is set.”
Message Byte Name Description
1 Byte0 03H: Three additional messages
Byte1 00H: Reserved
Byte2 01H: Group #1
2 Byte0 00H: Group name string table index
Byte1 15H: Group name string table number low byte
Byte2 01H: Group name string table number high byte
3 Byte0 01H: Group name help text string table index
Byte1 15H: Group name help text string table number low byte
Byte2 01H: Group name help text string table number high byte
4 Byte0 Standard IMPACC checksum
Byte1
Byte2
507-6 INCOM System Communications, June 2004
Communication Protocol for the Digital Input Module (DIM)
Transmit Setpoint Group 1, Block 1 Description (3 1 F) N=01:01:00 When this command is received, the DIM responds with messages that define the block of setpoints in this group.
Note: the name of the setpoints block and the ASCII help text for the block are identical to the corresponding text for the setpoints group.
Message Byte Name Description 1 Byte0 04H: Four additional messages
Byte1 01H: Block #1
Byte2 01H: Group #1
2 Byte0 04H: Block response is 4 messages long
Byte1 01H: One setpoint in this block
Byte2 00H: Reserved=0
3 Byte0 00H: Block name string table index
Byte1 15H: Block name string table number low byte
Byte2 01H: Block name string table number high byte
4 Byte0 01H: Block name help text string table index
Byte1 15H: Block name help text string table number low byte
Byte2 01H: Block name help text string table number high byte
5 Byte0 Standard IMPACC checksum
“”
“”
INCOM System Communications, June 2004 507-7
Communication Protocol for the Digital Input Module (DIM)
Transmit Group 1, Block 1, Setpoint 1 Description (3 1 F) N=01:01:01 When this command is received, the DIM responds with 20 messages that define the only setpoint in this block.
Message Byte Name Description 1 Byte0 14H: 20 additional messages
Byte1 01H: Block #1
Byte2 01H: Group #1
2 Byte0 01H: Setpoint #1
Byte1 90H: Setpoint #1 Configuration
Bit Definition
B7=1: Setpoint is active.
B6-B5=00B: Setpoint is settable by download.
B4=1: Setpoint is visible.
B3=0: Setpoint visibility cannot be enabled or disabled.
B2=0: Setpoint’s special value is not a dependency.
B1=0: Setpoint’s range is not a dependency.
B0=0: Setpoint’s conversion is not a dependency.
Byte2 00H: Bit offset of setpoint location
3 Byte0 06H: Byte offset of setpoint location
Byte1 01H: Setpoint format
B7=0: Setpoint special value is disabled.
B6=0: Max value field is not used as an exclusion mask.
B5-B3=000B: Reserved
B2-B0=001B: Format is unsigned integer.
Byte2 10H: Setpoint size is 16 bits.
4 Byte0-2 00H: Setpoint has no dependencies.
5 Byte0-2 00H: Setpoint has no dependencies.
6 Byte0-2 00H: Setpoint has no dependencies.
7 Byte0-2 00H: Setpoint has no dependencies.
8 Byte0-2 00H: Setpoint has no dependencies
507-8 INCOM System Communications, June 2004
Communication Protocol for the Digital Input Module (DIM)
Transmit Group 1, Block 1, Setpoint 1 Description (3 1 F) N=01:01:01 – Continued Message Byte Name Description
9 Byte0 00H: Setpoint has no dependencies.
Byte1-2 00H: b scale coefficient
10 Byte0 01H: c scale coefficient low byte
Byte1 00H: c scale coefficient high byte
Byte2 00H: Setpoint precision is to the nearest integer.
11 Byte0 01H: m scale coefficient low byte
Byte1 00H: m scale coefficient
Byte2 00H: m scale coefficient high byte
12 Byte0 01H: n scale coefficient low byte Byte1 00H: n scale coefficient
Byte2 00H: n scale coefficient high byte
13 Byte0 0FH: Setpoint minimum value (15 minutes) low byte
Byte1 00H: Setpoint minimum value high byte
Byte2 00H: Not used (setpoint is 16 bits long)
14 Byte0 60H: Setpoint max value (44,640 minutes = 31 days) low byte
Byte1 AEH: Setpoint maximum value high byte
Byte2 00H: Not used (setpoint is 16 bits long)
15 Byte0 01H: Setpoint step value (1 minute) low byte
Byte1 00H: Setpoint step value (1 minute) high byte
Byte2 00H: Not used (setpoint step is 16 bits long)
16 Byte0-2 00H: Setpoint special value is not used.
17 Byte0-2 00H: Setpoint special value string table is not used.
INCOM System Communications, June 2004 507-9
Communication Protocol for the Digital Input Module (DIM)
Transmit Group 1, Block 1, Setpoint 1 Description (3 1 F) N=01:01:01 – Continued Message Byte Name Description
18 Byte0 00H: Setpoint name string table index (“Inactivity Time”)
Byte1 15H: Setpoint name string table number low byte
Byte2 01H: Setpoint name string table number high byte
19 Byte0 07H: Setpoint engineering units string table index (“min”)
Byte1 00H: Setpoint engineering units string table number low byte
Byte2 00H: Setpoint engineering units string table number high byte
20 Byte0-2 00H: String table for help text
21 Byte0-2 Standard IMPACC checksum
507-10 INCOM System Communications, June 2004
Communication Protocol for the Digital Input Module (DIM)
Transmit Supported Command List (3 8 0) The (3 x x) commands supported by the DIM are listed in INCOM/IMPACC Slave-to-Master Supported Commands on Page 3. The module does not support any (3 0 F) N= expanded buffers. The following describes the response to the (3 8 0) command.
Message Byte Name Description 1 Byte0 0CH: 12 additional messages
03H: (3 0 1), (3 0 0) supported
00H: No commands in this range supported
2 Byte0 23H: (3 1 5), (3 1 1), (3 1 0) supported
9CH: (3 1 F), (3 1 C), (3 1 B), (3 1 A) supported
00H: No commands in this range supported
3 Byte0-2 00H: No commands in this range supported
4 Byte0-2 00H: No commands in this range supported
5 Byte0-2 00H: No commands in this range supported
6 Byte0-1 00H: No commands in this range supported
Byte2 15H: (3 8 4), (3 8 2), (3 8 0) supported
7 Byte0 5D : (3 8 E), (3 8 C), (3 8 B), (3 8 A), (3 8 8) supported
Byte1 00H: See note below
Byte2 00H: No commands in this range supported
8 Byte0 90H: (3 A 7), (3 A 4) supported
Byte1 01H: (3 A 8) supported
Byte2 00H: No commands in this range supported
9 Byte0-1 00H: No commands in this range supported
Byte2 83H: (3 C F), (3 C 9), (3 C 8) supported
10 Byte0 03H: (3 D 1), (3 D 0) supported
Byte1-2 00H: No commands in this range supported
INCOM System Communications, June 2004 507-11
Communication Protocol for the Digital Input Module (DIM)
Transmit Supported Command List (3 8 0) – Continued
Message Byte Name Description
11 Byte0-1 00H: No commands in this range supported
Byte2 0AH: (3 F B), (3 F 9) supported
12 Byte0 00H: Zero (3 0 F) N=xx:xx:xxH) commands supported
00H: Zero (3 0 F) N=xx:xx:xxH) commands supported
Byte2 00H: Zero (3 0 F) N=xx:xx:xxH) commands supported
13 Byte0-2 Standard IMPACC checksum
Note: The (3 9 0) and (3 9 1) test commands are hidden and so are not shown as being supported.
507-12 INCOM System Communications, June 2004
Communication Protocol for the Digital Input Module (DIM)
Transmit Supported Slave Action List (3 8 2) The DIM responds with 7 data messages specifying which Slave Action commands (3 D 0) N= are supported:
Message Byte Name Description 1 Byte0 07H: Seven additional messages
Byte1 07H: Low-order byte of number of Slave Action commands (7)
Byte2 00H : High-order byte of number of Slave Action commands (7)
2 Byte0 01H: N=00:00:01 Reset Alarm
Byte1 00H: N=00:00:01 Reset Alarm
Byte2 00H: N=00:00:01 Reset Alarm
3 Byte0 03H: N=00:00:03 Reset Powered-up Indicator
Byte1 00H: N=00:00:03 Reset Powered-up Indicator
Byte2 00H: N=00:00:03 Reset Powered-up Indicator
4 Byte0 80H: N=00:00:80 Take Snapshot
Byte1 00H: N=00:00:80 Take Snapshot
Byte2 00H: N=00:00:80 Take Snapshot
5 Byte0 02H: N=03:00:02 Reset INCOM Slave-Interface Statistics
Byte1 00H: N=03:00:02 Reset INCOM Slave-Interface Statistics
Byte2 03H: N=03:00:02 Reset INCOM Slave-Interface Statistics
6 Byte0 07H: N=03:00:07 Save Setpoints and Exit Session supported
Byte1 00H:
Byte2 03H:
7 Byte0 0AH: N=03:00:0A Abort Setpoints Download and Exit Session
Byte1 00H: N=03:00:0A Abort Setpoints Download and Exit Session
Byte2 03H N=03:00:0A Abort Setpoints Download and Exit Session
8 Byte0 01H: N=03:01:01 Reset Setpoints Change Flag supported
Byte1 01H: N=03:01:01 Reset Setpoints Change Flag supported
Byte2 03H N=03:01:01 Reset Setpoints Change Flag supported
INCOM System Communications, June 2004 507-13
Communication Protocol for the Digital Input Module (DIM)
Transmit Supported (D x x) Broadcast List (3 8 4) The DIM responds with 2 data messages specifying which broadcast commands (D x x) are supported:
Message Byte Name Description 1 Byte0 01H: One additional message
01H: Low-order byte of number of Broadcast commands (1)
00H : High-order byte of number of Slave Action commands (1)
2 Byte0 00H: (D 0 0) Save Energy
Byte1 00H: Not used
Byte2 00H: Not used
507-14 INCOM System Communications, June 2004
Communication Protocol for the Digital Input Module (DIM)
Transmit Supported Subnetwork Addresses (3 8 8) The DIM responds with 2 data messages specifying which subnetwork addresses (0x001 to 0x004) are supported:
Message Byte Name Description 1 Byte0 02H: Two additional message
Byte1 04H: Low-order byte of number of supported network addresses
Byte2 00H : High-order byte of number of supported network addresses
2 Byte0 04H: Low byte of upper range of supported network addresses
Byte1 10H: Bit Definition
B7-B4 Low nibble of lower range of supported network addresses
B3-B0 High nibble of upper range of supported network addresses
Byte2 00H: High byte of lower range of supported network addresses
3 Byte0-2 Standard IMPACC checksum
INCOM System Communications, June 2004 507-15
Communication Protocol for the Digital Input Module (DIM)
Transmit Maximum Response Time (3 8 A) The DIM responds with a single data message containing the maximum response time to any (3 x x) command, in seconds, as follows:
Message Byte Name Description
1 Byte0 05H: Low-order byte of 16-bit magnitude (5ms)
Byte1 00H: High-order byte of 16-bit magnitude (5ms)
Byte2 7DH : Bit Definition B7=0: Unsigned integer
B6=1: Valid data
B5=1: Multiplier is a power of 10.
B4-B0 1DH: exponent = -3
Transmit (3 8 B) Response Length (3 8 x) The DIM responds with 3 data messages containing the number of messages in each (3 8 x) response, beginning with (3 8 0) and ending with (3 8 8). A response length of zero means the command is not supported.
Message Byte Name Description 1 Byte0 0DH: (3 8 0) response length is 13 messages.
Byte1 00H: (3 8 1) is not supported.
Byte2 08H : (3 8 2) response length is 8 messages.
2 Byte0 00H: (3 8 3) is not supported.
Byte1 02H: (3 8 4) response length is 2 messages.
Byte2 00H : (3 8 5) is not supported.
3 Byte0 00H : (3 8 6) is not supported.
Byte1 00H: (3 8 7) is not supported.
Byte2 03H : (3 8 8) response length is 3 messages
507-16 INCOM System Communications, June 2004
Communication Protocol for the Digital Input Module (DIM)
Transmit ASCII String Length (3 8 C) N=TT:TT:EE The DIM responds with a single message containing the number of characters in the string (including the NULL character at the end of the string) and the number of messages returned by the corresponding (3 8 E) N=TT:TT:EE command. If the string is not supported, a (3 1 B) NACK is returned.
Message Byte Description 1 Byte0 Number of msgs in the corresponding (3 8 E, N=TT:TT:EE) command
Byte1 Number of characters in the string
Byte2 Reserved = 0
Transmit Standard ASCII String (3 8 E) N=TT:TT:EE The DIM responds with the ASCII string from Table TT:TT and indexed by “EE.” The response structure is as follows.
Message Byte Description 1 Byte0 Number of additional messages
Byte1 String table entry index
Byte2 String table ID (low byte)
2 Byte0 String table ID (high byte)
Byte1 First ASCII character of string
Byte2 Second ASCII character of string
… … …
m-1 Byte0 nth ASCII character of string or NULL
Byte1 Last ASCII character of string or NULL
Byte2 NULL
m Byte0-2 Standard IMPACC checksum
INCOM System Communications, June 2004 507-17
Communication Protocol for the Digital Input Module (DIM)
Test Command: Enter Factory Test Mode (3 9 0) This command causes the DIM to enter test mode if the Test Mode Enable jumper is installed. The command sequence is as follows:
1. The master sends a (3 9 0) control message.
2. The DIM responds with a 24-bit random challenge code in the following format:
Message Byte Description 1 0 24-bit challenge code LSB
1 24-bit challenge code Byte1
2 24-bit challenge code MSB
3. The master calculates the next 24-bit code in the authentication sequence using the challenge code as a seed. The master sends the response as a data message:
Message Byte Description 1 0 24-bit response code LSB
1 24-bit response code Byte1
2 24-bit response code MSB
4. If the response code is accepted, the DIM enters test mode and responds with an ACK (3 1 0). Otherwise the module does not enter test mode and a NACK (3 1 1) is returned.
5. The DIM remains in test mode until power is cycled.
6. The master must use the following algorithm to calculate the next 24-bit code in the authentication sequence:
master response code = challenge code + 7
7. If the Test Mode Enable Jumper is not installed (normal condition), the DIM does not enter Test Mode and responds with a NACK (3 1 1) to this command.
507-18 INCOM System Communications, June 2004
Communication Protocol for the Digital Input Module (DIM)
Test Command: Clear DIM Counters (3 9 1) This is a factory test command. If the DIM is in test mode and the Test Mode Enable jumper is installed, the following actions occur:
1. All 4 DIM and pulse counters are cleared.
2. The valid data flag for each counter is set.
3. The counter inactivity flags and timers are reset.
4. The EEPROM checksum error flag is cleared.
5. The DIM then responds with an ACK.
Note: This is the only method of clearing the counters and setting the valid data flag.
If the DIM is not in test mode or the Test Mode Enable jumper is not installed, it will respond with a NACK.
Transmit INCOM Slave-Interface Statistics Buffer (3 A 4) When this command is received, the DIM responds with 10 data messages that contain the values for several INCOM communication-related counters. These counters are maintained by the DIM and provide a measure of the integrity of the communication path between it and the master. Refer to IL 17384, Part A, “INCOM Communications Standard” for a complete description of the response to this command.
The counters are reset by a (3 D 0) N=03:00:02H Reset INCOM Slave-Interface Statistics Slave Action command.
Note: One set of statistics is kept. These statistics include both the main network and all 4 virtual subnetworks.
Transmit Checksum of Previous Data Buffer (3 A 7) When this command is received, the DIM responds with the checksum of the most recently sent data buffer. Refer to IL 17384, Part A, “INCOM Communications Standard” for a complete description of the response to this command.
Note that one set of statistics is kept. These statistics include both the main network and all 4 virtual subnetworks.
INCOM System Communications, June 2004 507-19
Communication Protocol for the Digital Input Module (DIM)
Transmit Change Notification (3 A 8) When this command is received, the DIM responds with 2 data messages containing flags indicating the capabilities of the product along with changes in power, logging (not used) or setpoints.
Message Byte Name Description 1 Byte0 05H Bit Definition
B7-B3 Reserved = 0
B2=1 DIM may have a setpoint downloaded to it
B1=0 Non-Volatile Event ID (not used)
B0=1 DIM is a subnetwork master.
Byte1 x00x0000B
Bit Definition
B7 Powered-up indicator. This flag is set when the DIM is powered up or after a reset. It is cleared by the Slave Action (3 D 0) N=00:00:03 Reset Powered-Up Indicator command.
Byte2 B6=0 Trigger reconfiguration flag (not used)
B5=0 Log reconfiguration flag (not used)
B4 Setpoints change flag. This flag is set whenever the DIM setpoint is changed. It is reset by the (3 D 0) N=03:01:01 Reset Setpoints Change Flag command.
B3=0 RTC update request (not used)
B2-B0 Reserved = 0
XXH Plug n’ Play version
2 Byte0-2 00H Event/Log change notification (not used)
507-20 INCOM System Communications, June 2004
Communication Protocol for the Digital Input Module (DIM)
Transmit Digital Inputs (3 C 8) This command is used to read the status of all 8 digital inputs. When the DIM receives this command, it reads the status of the digital inputs and then responds with 2 data messages:
Message Byte Name Description
1 Byte0 01 One additional message
Byte1 08H Number of digital inputs
Byte2 State of the digital inputs. Bit assignments are as follows:
Bit Definition
B7 Input Z4
B6 Input Y4
B5 Input Z3
B4 Input Y3
B3 Input Z2
B2 Input Y2
B1 Input Z1
B0 Input Y1
A “1” indicates that the given input is TRUE or active (the contact is closed to the +24V wetting supply).
2 Byte0-2 Checksum of the previous message
INCOM System Communications, June 2004 507-21
Communication Protocol for the Digital Input Module (DIM)
Transmit Setpoint Structure (3 C 9) When this command is received, the DIM responds with 23 data messages that define the arrangement of the setpoint groups and blocks.
Message Byte Name Description 1 Byte0 16H: 22 additional messages
Byte1 Product firmware revision number
Byte2 Product firmware version number
2 Byte0 Setpoints sequence number low byte
Byte1 Setpoints sequence number high byte
Byte2 x0000001B: Setpoints state
Bit Definition
B7=1: Setpoints download is active over INCOM.
B7=0: Setpoints download is not active over INCOM.
B6=0: Setpoints download is not active using a non-INCOM method.
B5-B0=0x01H: One active setpoint group 3 Byte0 01H: One block in setpoints Group #1
Byte1 00H: Group #2 is not used.
Byte2 00H: Group #3 is not used.
4-22 Byte0-2 00H: Groups #4-#60 are not used.
23 Byte0-2 Standard IMPACC checksum
507-22 INCOM System Communications, June 2004
Communication Protocol for the Digital Input Module (DIM)
Transmit Setpoint Download Error String (3 C F) N=00:00:00 When this command is received, the DIM responds with an ASCII string that describes the setpoints download error. If no error occurred in the last download session, the string will be null.
Message Byte Name Description
1 Byte0 03H: Number of additional messages
Byte1 01H: Block #1
Byte2 01H: Group #1
2 Byte0 01H: Setpoint #1
Download error flag code:
Bit Definition
0x00 No error
0x01 Checksum error
0x02 CRC error
0x03 No download session
0x04 Value exceeds maximum
0x05 Value less than minimum
0x06 Illegal value within range
0x07 Mismatch on read-only setpoint
0x08 Illegal group/block specified
0x09 Sequence number mismatch
0x0B No setpoints received
Byte2 00H: Reserved
3 Byte0 String table index of error string (for NULL string)
Byte1 16H: Low byte of string table number of error string
Byte2 01H: High byte of string table number of error string
4 Byte0-2 Standard IMPACC checksum
INCOM System Communications, June 2004 507-23
Communication Protocol for the Digital Input Module (DIM)
Transmit Setpoint Group 1, Block 1 (3 C F) N=80:01:01 When this command is received, the DIM responds with the single setpoint contained in Block #1 of Group #1.
Message Byte Name Description 1 Byte0 03H: Three additional messages
Byte1 01H: Block #1
Byte2 01 H: Group #1
2 Byte0 Setpoints sequence number low byte
Byte1 Setpoints sequence number high byte
Byte2 00H: Reserved
3 Byte0 Setpoint #1 (Inactivity Time) low byte
Byte1 Setpoint #1 (Inactivity Time) high byte
Byte2 00H: Not used
4 Byte0-2 Standard IMPACC checksum
507-24 INCOM System Communications, June 2004
Communication Protocol for the Digital Input Module (DIM)
Slave Action Command (3 D 0) This command requests the DIM to perform some action. When the (3 D 0) request is received, the DIM responds as follows:
1. The DIM returns an ACK (3 1 0) response to the (3 D 0) command.
2. The MASTER then sends the DIM a Slave Action number as a 24-bit data message.
3. The DIM performs the requested action if appropriate.
4. The DIM responds with an ACK (3 1 0) or NACK (3 1 1) depending on successful completion of the requested action.
The following Slave Action command numbers have been implemented in the DIM and will be acknowledged. All others will be rejected.
N = 00:00:01H Reset Alarm Clears the diagnostic warning issued in the (3 0 1) command.
N = 00:00:03H Reset Powered-Up Indicator Clears the Powered-Up Indicator Flag in the (3 A 8) Change Notification response.
N = 00:00:80H Save Energy Loads the present DIM counter values, present pulse counter values, present counter status, and present digital input status for all 4 channels into a buffer to be read by the (3 D 1)(3 C E) subnetwork command.
N = 03:00:02H Reset INCOM Slave-Interface Statistics Resets the counter values issued by a (3 A 4) command.
N = 03:00:0AH Abort Setpoints Download and Exit Session Terminates a setpoint download session and directs the DIM to discard the downloaded setpoints and continue operation with the previous setpoint set.
N = 03:01:01H Reset Setpoints Change Flag Resets the Setpoints Change Flag in the (3 A 8) response buffer. Refer to Transmit Change Notification (3 A 8) on Page 20.
N = 03:00:07H Save Setpoints and Exit Session Terminates a setpoint download session and directs the DIM to begin using the downloaded setpoints. Note that when the Inactivity Time is received, the Inactivity Timers are reloaded (reset) with the new value. The state of each Inactivity Flag is not changed.
INCOM System Communications, June 2004 507-25
Communication Protocol for the Digital Input Module (DIM)
Process Subnetwork Command (3 D 1) This command is primarily used for communicating with the 4 meters in the DIM. It informs the DIM that one or more data messages will follow. The first data message of the group contains the instruction, command, branch circuit address, and subcommand of a control message for a meter in the DIM. Additional data messages in the group will be processed by the DIM as data messages destined for the selected branch circuit (or meter) address. The sequence of operations is as follows:
1. The INCOM master sends the DIM a Process Sub-Network Command (3 D 1).
2. The DIM responds with its Fast Status. Refer to Status (3 0 0) on Page 4.
3. The INCOM master sends the DIM a data message containing the instruction, command, branch circuit address, and subcommand of a control message to be executed by a meter in the DIM. The format of this data message is identical to the equivalent control message, except the C/D bit is set to “data.” The DIM verifies that the branch circuit address is valid (the meter ID exists).
If the meter ID does not exist, the DIM responds with a (3 1 1) Negative Acknowledgement control message.
♦
♦
♦
♦
♦
♦
If the appropriate meter ID has been configured, the DIM executes the command and returns the appropriate response message(s) to the INCOM master.
4. If the subnetwork command requires additional data messages, the INCOM master sends them to the DIM.
Refer to Master-to-DIM Command Set on Page 3 for the INCOM master to DIM meter command set.
Meter Addresses Valid branch circuit addresses are as follows:
Channel 1: 001H
Channel 2: 002H
Channel 3: 003H
Channel 4: 004H
507-26 INCOM System Communications, June 2004
Communication Protocol for the Digital Input Module (DIM)
Write Setpoint Block (3 F 9) When this command is received, the DIM responds with an ACK if a Setpoints Download Session has been opened. Otherwise a NACK is returned. Subsequent data messages from the INCOM master, shown below, are then received. If the messages are correct, the DIM responds with an ACK. Otherwise a NACK is returned, and the error code is set accordingly. [Refer to Transmit Setpoint Download Error String (3 C F) N=00:00:00 on Page 23.] An ACK is returned for the final (checksum) message only if all messages were correct and the checksum is correct. Otherwise, a NACK is returned for the checksum.
Message Byte Name Description 1 Byte0 03H: Three additional messages
Byte1 01H: Block #1
Byte2 01H: Group #1
2 Byte0 Setpoints sequence number low byte
Byte1 Setpoints sequence number high byte
Byte2 00H: Reserved
3 Byte0 Setpoint #1 (Inactivity Time) low byte
Byte1 Setpoint #1 (Inactivity Time) high byte
Byte2 00H: Not used
4 Byte0-2 Standard IMPACC checksum
INCOM System Communications, June 2004 507-27
Communication Protocol for the Digital Input Module (DIM)
Open Setpoints Download Session Request (3 F B) The INCOM master sends 3 data messages, shown below, along with this command. If the messages are correct, the DIM responds with an ACK, and sets a flag allowing setpoints to be downloaded (a setpoints download session is opened). If a session has already been opened (flag is already TRUE) or one of the data messages is incorrect, the DIM responds with a NACK.
Message Byte Name Description 1 Byte0 02H: Two additional messages
Byte1 Setpoints sequence number low byte
Byte2 Setpoints sequence number high byte
2 Byte0 Master ID low byte
Byte1 Master ID high byte
Byte2 01H: Open setpoints download
3 Byte0-2 Standard IMPACC checksum
507-28 INCOM System Communications, June 2004
Communication Protocol for the Digital Input Module (DIM)
Save Energy Broadcast Command (D 0 0) This is a broadcast command. It has no response. When the (D 0 0) command is received, the DIM loads the present DIM counter values, present pulse counter values, present counter status, and present digital input status for all 4 channels into a buffer to be read by the (3 D 1)(3 C E) subnetwork command.
INCOM System Communications, June 2004 507-29
Communication Protocol for the Digital Input Module (DIM)
Master-to-DIM Module Meter Command Set The following INCOM subnetwork commands in the following table are supported by the DIM and explained in this section.
INCOM/IMPACC Master-to-Slave Subnetwork Supported Commands (3 D 1)(3 0 0) Status
(3 D 1)(3 0 1) Extended Status
(3 D 1)(3 8 0) Transmit Supported Command List
(3 D 1)(3 8 2) Transmit Supported Slave Action List
(3 D 1)(3 8 4) Transmit Supported (D x x) Broadcast List
(3 D 1)(3 8 A) Transmit Maximum Response Time
(3 D 1)(3 8 B) Transmit (3 8 x) Response Length
(3 D 1)(3 8 C) Transmit ASCII String Length
(3 D 1)(3 8 E) Transmit Standard ASCII String
(3 D 1)(3 A 8) Transmit Change Notification
(3 D 1)(3 C D) Transmit Counter Values
(3 D 1)(3 C E) Transmit Saved Counter Values
(3 D 1)(3 D 0) Slave Action
(D 0 0) Save Energy Request Broadcast
507-30 INCOM System Communications, June 2004
Communication Protocol for the Digital Input Module (DIM)
Status (3 D 1)(3 0 0) The DIM responds with a 3-byte data message with the following format:
BYTE2 | BYTE1 | BYTE0 |
MSB | | LSB |
S7 S6 S5 S4 S3 S2 S1 S0 | P5 P4 P3 P2 P1 P0 V3 V2 | V1 V0 D5 D4 D3 D2 D1 D0 |
where
D5 D4 D3 D2 D1 D0 => Division/class code = 36 (meter).
V3 V2 V1 V0 => Communications software version 1.
P5 P4 P3 P2 P1 P0 => Product ID = 1.
The remaining bits are defined as follows:
Bit Definition
S7-S6: 00 Normal – Inactive (unused)
Normal – Active
10 Abnormal – Inactive (unused)
Abnormal – Active (Alarm – Counter Malfunction)
S5-S2: 0 Reserved
S1: Inactive Detector Flag
S0: 0 (3 A 8) Change Notification (never changes)
The Abnormal bit (S7) is set when the counter data is invalid. This occurs under the following condition:
Upon initialization, a checksum error is detected when the counter values are retrieved from EEPROM.
♦
The Abnormal bit can only be cleared if the master resets the counters. This may be done at the factory using the (3 9 0) and (3 9 1) test commands.
The Inactive Detector Flag (S1) is set when the channel’s counter had been active, but then was inactive for the Inactive Time. The Inactive Time is a setpoint ranging from 15 minutes to 45 days. S1 is cleared via the (3 D 1)(3 D 0) N=00:04:nn Reset Inactivity Flag slave action command. Refer to Slave Action Command (3 D 1)(3 D 0) on Page 46.
Note: A channel’s Inactive Detector Flag will be reset upon initialization. If the counter is never active (as when a channel is not used), the flag will never be set. It is only set if the channel’s counter had been active and then was inactive for the Inactive Time.
The (3 A 8) Change Notification Flag (S0) is set when any bit in the (3 A 8) response changes from a “zero” to a “one.” The (3 A 8) response never changes. Therefore, S0 is always 0.
INCOM System Communications, June 2004 507-31
Communication Protocol for the Digital Input Module (DIM)
Extended Status (3 D 1)(3 0 1) The DIM responds with 2 data messages that conform to the following format.
Message 1 is identical to the response to the (3 0 0) command. ♦
♦ Message 2 is defined per the Plug n’ Play protocol for Primary Status, Secondary Status, and Cause-of-Status. Message 2 format is as follows:
BYTE2 | BYTE1 | BYTE0 |
MSB | | LSB |
P7 P6 P5 P4 P3 P2 P1 P0 | S4 S3 S2 S1 S0 C10 C9 C8 | C7 C6 C5 C4 C3 C2 C1 C0 |
where
P7 P6 … P0 => Primary Status.
S4 S3 S2 S1 S0 => Secondary Status.
C10 C9 … C0 => Cause of Status.
Valid responses are summarized in Table 5 as follows.
Table 5: Valid Responses (3 D 1)(3 0 1)
Response Priority
Primary Status
Secondary Status
Cause of Status
Description
1
(highest)
4
(Alarm)
1
(Not Applicable)
40
(Diagnostic Fail)
Diagnostic failure occurred on powerup
2 9 (Running)
8
(Device in Alarm)
2
(External condition #1)
One or more channels are inactive
3
(lowest)
9 (Running)
1
(Not Applicable)
1
(Normal)
Normal operation
A diagnostic failure occurs if after a reset the module firmware detects a checksum error upon retrieval of the counter values. Normal operation continues, but both the checksum error and the error flag are maintained unless cleared by the INCOM master.
The error is cleared only if the master resets the counters. This may be done at the factory using the (3 9 0) and (3 9 1) test commands.
507-32 INCOM System Communications, June 2004
Communication Protocol for the Digital Input Module (DIM)
Transmit Supported Command List (3 D 1)(3 8 0) The (3 x x) commands supported by the DIM are listed in Master-to-DIM Module Meter Command Set on Page 30. The module does not support any (3 0 F) N= expanded buffers. The following list describes the response to the (3 8 0) command.
Message Byte Name Description 1 Byte0 0CH: 12 additional messages
03H: (3 0 1), (3 0 0) are supported.
00H: No commands in this range are supported.
2 Byte0 03H: (3 1 1), (3 1 0) are supported.
0AH: (3 1 B), (3 1 9) are supported.
00H: No commands in this range are supported.
3-5 Byte0-2 00H: No commands in these ranges are supported.
6 Byte0 00H: No commands in this range are supported.
Byte1 00H: No commands in this range are supported.
Byte2 15H: (3 8 4), (3 8 2), and (3 8 0) are supported.
7 Byte0 5CH: (3 8 E), (3 8 C), (3 8 B), and (3 8 A) are supported.
Byte1 00H: No commands in this range are supported.
Byte2 00H: No commands in this range are supported.
8 Byte0 00H: No commands in this range are supported.
Byte1 01H: (3 A 8) is supported.
Byte2 00H: No commands in this range are supported.
9 Byte0 00H: No commands in this range are supported.
Byte1 00H: No commands in this range are supported.
Byte2 60H: (3 C E), (3 C D) are supported.
10 Byte0 01H: (3 D 0) is supported.
Byte1 00H: No commands in this range are supported.
Byte2 00H: No commands in this range are supported.
INCOM System Communications, June 2004 507-33
Communication Protocol for the Digital Input Module (DIM)
Transmit Supported Command List (3 D 1)(3 8 0) – Continued
Message Byte Name Description
11 Byte0 00H: No commands in this range are supported.
Byte1 00H: No commands in this range are supported.
Byte2 00H: No commands in this range are supported.
12 Byte0 00H: Zero (3 0 F, N=xx:xx:xxH) commands are supported.
Byte1 00H: Zero (3 0 F, N=xx:xx:xxH) commands are supported.
Byte2 00H: Zero (3 0 F, N=xx:xx:xxH) commands are supported.
13 Byte0-2 Standard IMPACC checksum
507-34 INCOM System Communications, June 2004
Communication Protocol for the Digital Input Module (DIM)
Transmit Supported Slave Action List (3 D 1)(3 8 2) The DIM responds with 5 data messages specifying which Slave Action commands (3 D 0) N= are supported.
Message Byte Name Description 1 Byte0 04H: Four additional messages
Byte1 04H: Low-order byte of number of Slave Action commands (4)
Byte2 00H : High-order byte of number of Slave Action commands (4)
2 Byte0 80H: N=00:00:80 Take Snapshot
Byte1 00H: N=00:00:80 Take Snapshot
Byte2 00H: N=00:00:80 Take Snapshot
3 Byte0 01H: N=00:04:01 Reset Inactivity Flag
Byte1 04H: N=00:04:01 Reset Inactivity Flag
Byte2 00H: N=00:04:01 Reset Inactivity Flag
4 Byte0 04H: N=00:04:04 Reset Inactivity Flag
Byte1 04H: N=00:04:04 Reset Inactivity Flag
Byte2 00H: N=00:04:04 Reset Inactivity Flag
5 Byte0 06H: N=03:00:06 Acknowledge Energy Reset
Byte1 00H: N=03:00:06 Acknowledge Energy Reset
Byte2 03H: N=03:00:06 Acknowledge Energy Reset
INCOM System Communications, June 2004 507-35
Communication Protocol for the Digital Input Module (DIM)
Transmit Supported (D x x) Broadcast List (3 D 1)(3 8 4) The DIM responds with 2 data messages specifying which Broadcast commands (D x x) are supported:
Message Byte Name Description 1 Byte0 01H: One additional message
Byte1 01H: Low-order byte of number of Broadcast commands (1)
Byte2 00H : High-order byte of number of Slave Action commands (1)
2 Byte 0 00H: Save Energy (D 0 0)
Byte 1 00H: Not used
Byte2 00H: Not used
507-36 INCOM System Communications, June 2004
Communication Protocol for the Digital Input Module (DIM)
Transmit Maximum Response Time (3 D 1)(3 8 A) The DIM responds with a single data message containing the maximum response time to any (3 x x) command, in seconds, as follows.
Message Byte Name Description 1 Byte0 05H: Low-order byte of 16-bit magnitude (5ms)
Byte1 00H: High-order byte of 16-bit magnitude (5ms)
Byte2 7DH : Bit Definition
B7=0 Unsigned integer
B6=1 Valid data
B5=1 Multiplier is a power of 10
B4-B0=1DH: Exponent = -3
INCOM System Communications, June 2004 507-37
Communication Protocol for the Digital Input Module (DIM)
Transmit (3 8 x) Response Length (3 D 1)(3 8 B) The DIM responds with 3 data messages containing the number of messages in each (3 8 x) response, beginning with (3 8 0) and ending with (3 8 8). A response length of zero means the command is not supported.
Message Byte Name Description 1 Byte0 0DH: (3 8 0) response length is 13 messages.
Byte1 00H: (3 8 1) is not supported.
Byte2 05H : (3 8 2) response length is 5 messages.
2 Byte0 00H: (3 8 3) is not supported.
Byte1 02H: (3 8 4) response length is 2 messages.
Byte2 00H : (3 8 5) is not supported.
3 Byte0 00H : (3 8 6) is not supported.
Byte1 00H: (3 8 7) is not supported.
Byte2 00H : (3 8 8) is not supported.
507-38 INCOM System Communications, June 2004
Communication Protocol for the Digital Input Module (DIM)
Transmit ASCII String Length (3 D 1)(3 8 C) N=TT:TT:EE The DIM responds with a single message containing the number of characters in the string (including the NULL character at the end of the string) and the number of messages returned by the corresponding (3 D 1)(3 8 E) N=TT:TT:EE command. If the string is not supported, a (3 1 B) NACK is returned.
Message Byte Description 1 Byte0 Number of msgs in the corresponding (3 8 E, N=TT:TT:EE) command
Byte1 Number of characters in the string
Byte2 Reserved = 0
INCOM System Communications, June 2004 507-39
Communication Protocol for the Digital Input Module (DIM)
Transmit Standard ASCII String (3 D 1)(3 8 E) N=TT:TT:EE The DIM responds with the ASCII string from Table TT:TT and indexed by “EE.” The response structure is as follows:
Message Byte Description 1 Byte0 Number of additional messages
Byte1 String table entry index
Byte2 String table ID (low byte)
2 Byte0 String table ID (high byte)
Byte1 First ASCII character of string
Byte2 Second ASCII character of string
… … …
m-1 Byte0 nth ASCII character of string or NULL
Value Definition
1 Last ASCII character of string or NULL
2 NULL
m Byte0-2 Standard IMPACC checksum
507-40 INCOM System Communications, June 2004
Communication Protocol for the Digital Input Module (DIM)
Transmit Change Notification (3 D 1)(3 A 8) When this command is received, the DIM responds with 2 data messages containing flags indicating the capabilities of the virtual subneworked product (the meter), along with changes in power, logging (not used), or setpoints (not used).
Message Byte Name Description 1 Byte0 00H Bit Definition
B7-B3 Reserved = 0 B2=0 Cannot download setpoints
B1=0 Non-Volatile Event ID (not used)
B0=0 Meter is not a subnetwork master.
Byte1 00H Bit Definition
B7=0 Powered-up indicator (not used)
B6=0 Trigger reconfiguration flag (not used)
B5=0 Log reconfiguration flag (not used)
B4=0 Setpoints change flag (not used)
B3=0 RTC update request (not used)
B0: Reserved = 0
Byte2 XXH Plug n’ Play version
2 Byte0-2 00H Event/Log change notification (not used)
INCOM System Communications, June 2004 507-41
Communication Protocol for the Digital Input Module (DIM)
Transmit Channel Values (3 D 1)(3 C D) The DIM responds with a 6-message buffer containing the Z and Y digital inputs, the 32-bit DIM counter value, the 32-bit Z-pulse counter value, the 32-bit Y-pulse counter value, the counter status flags, and a checksum. The 6 messages are as follows.
Message Byte Name Description 1 Byte0 05H: Five additional messages
Byte1 Digital Inputs
Bit Definition
B7-B2 Reserved = 0
B1 Z-input State
B0 Y-input State
A “1” indicates that the given input is TRUE or active. (The is closed to the +24V wetting supply).
Byte2 Counter Status flags:
Bit Definition
B7: 1 = DIM, Z-pulse, and Y-pulse counters have been reset to zero.
0 = Slave Action 03:00:06H has been received.
B6-B3 Reserved = 0
B2 1 = Valid DIM counter data
0 = Invalid DIM counter data
B1 1 = Valid Z-Pulse counter data
0 = Invalid Z-Pulse counter data
B0 1 = Valid Y-Pulse counter data
0 = Invalid Y-Pulse counter data
2 Byte0 DIM counter LSB
Byte1 DIM counter Byte1
Byte2 DIM counter Byte2
3 Byte0 DIM counter MSB
Byte1 Y-Pulse counter LSB
Byte2 Y-Pulse counter Byte1
4 Byte0 Y-Pulse counter Byte
Byte1 Y-Pulse counter MSB
Byte2 0: Z-Pulse counter LSB (not used)
507-42 INCOM System Communications, June 2004
Communication Protocol for the Digital Input Module (DIM)
Transmit Channel Values (3 D 1)(3 C D) – Continued Message Byte Name Description
5 Byte0 0: Z-Pulse counter Byte1 (not used)
Byte1 0: Z-Pulse counter Byte2 (not used)
Byte2 0: Z-Pulse counter MSB (not used)
6 Byte0 Standard IMPACC checksum low byte
Byte1 Standard IMPACC checksum high byte
Byte2 Standard IMPACC checksum, one's complement of the low byte
Byte 2 of Message 1 contains the Counter Status flags. There are two flags: the valid data flag and the counter reset flag.
The valid data flag is clear (i.e., the data is invalid) under the following condition:
Upon initialization, a checksum error is detected when the counter values are retrieved from EEPROM.
♦
The valid data flag can only be cleared if the master resets the counters. This may be done at the factory using the (3 9 0) and (3 9 1) test commands.
The counter reset flag is set when the counters have been reset using the (3 9 0) and (3 9 1) test commands. This flag is cleared by the Subnetwork Slave Action Command (3 D 1)(3 D 0) N=03:00:06H. DIMs are shipped from the factory with the counters clear and the reset flag set.
INCOM System Communications, June 2004 507-43
Communication Protocol for the Digital Input Module (DIM)
Transmit Saved Channel Values (3 D 1)(3 C E) The DIM responds with a 6-message buffer containing an image of the Z and Y digital inputs, the 32-bit DIM counter value, the 32-bit Z-pulse counter value, the 32-bit Y-pulse counter value, and the counter status flags at the time a “snapshot request” was received. The standard IMPACC checksum for the message is also returned. The master causes the image to be saved by issuing a “snapshot request” using one of the following commands:
Save Energy Broadcast Command (D 0 0) ♦
♦
♦
Save Energy Slave Action Command (3 D 0) N=00:00:80H
Save Energy Slave Action Command (3 D 1) (3 D 0) N=00:00:80H
The 6 messages comprising the response are as follows.
Message Byte Name Description 1 Byte0 05H: Five additional messages
Byte1 Digital Inputs
Bit Definition
B7-B2 Reserved = 0
B1 Z-input State
B0 Y-input State
A “1” indicates that the given input is TRUE or active (the contact is closed to the +24V wetting supply).
Byte2 Counter and Digital Input Status flags:
Bit Definition B7 1 = DIM, Z-pulse, and Y-pulse counters have been reset to zero.
0 = Slave Action 03:00:06H has been received.
B6 1 = First time (3 C E) has been received since a Save Energy command.
0 = (3 C E) has been received previously.
B5 1 = Valid digital input data (A snapshot has been taken.)
0 = Invalid digital input data (A snapshot has not been taken.)
B4-B3 Reserved = 0
B2 1 = Valid DIM counter data
0 = Invalid DIM counter data
B1: 1 = Valid Z-Pulse counter data
0 = Invalid Z-Pulse counter data
B0: 1 = Valid Y-Pulse counter data
0 = Invalid Y-Pulse counter data
507-44 INCOM System Communications, June 2004
Communication Protocol for the Digital Input Module (DIM)
Transmit Saved Channel Values (3 D 1)(3 C E) – Continued Message Byte Name Description
2 Byte0 KYZ counter LSB Byte1 KYZ counter Byte1
Byte2 KYZ counter Byte2
3 Byte0 KYZ counter MSB
Byte1 Y-Pulse counter LSB
Byte2 Y-Pulse counter Byte1
4 Byte0 Y-Pulse counter Byte2
Byte1 Y-Pulse counter MSB
Byte2 0: Z-Pulse counter LSB (not used)
5 Byte0 0: Z-Pulse counter Byte1 (not used)
Byte1 0: Z-Pulse counter Byte2 (not used)
Byte2 0: Z-Pulse counter MSB (not used)
6 Byte0 Standard IMPACC checksum low byte
Byte1 Standard IMPACC checksum high byte
Byte2 Standard IMPACC checksum ones complement of the low byte
Byte 2 of Message 1 contains the counter status flags. There are 3 types of flags: the new snapshot flag, the valid data flag, and the counter reset flag.
The new snapshot flag is set when a snapshot request command has been received and the image has been updated with the present counter and digital input data and status. It is cleared after a (3 C E) command has been received.
The valid data flag is clear (data is invalid) under either of the following conditions:
Upon initialization, a checksum error is detected when the counter values are retrieved from EEPROM.
♦
♦ A snapshot command was never received.
When either of the valid snapshot commands is received, the data will be valid, provided there is not a checksum error. The checksum error can only be cleared if the master resets the counters. This may be done at the factory using the (3 9 0) and (3 9 1) test commands.
The counter reset flag is set when the counters have been reset using the (3 9 0) and (3 9 1) test commands. This flag is cleared by the Sub-Network Slave Action Command (3 D 1)(3 D 0) N=03:00:06H. DIMs are shipped from the factory with the counters clear and the reset flag set.
Note that the valid data flag and the counter reset flag reflect the state of the data at the time the snapshot was taken. This may be different from the state of the present data.
INCOM System Communications, June 2004 507-45
Communication Protocol for the Digital Input Module (DIM)
Slave Action Command (3 D 1)(3 D 0) This command requests the DIM to perform some action. When the (3 D 0) request is received, the DIM responds as follows:
1. The DIM returns an ACK (3 1 0) response to the (3 D 0) command.
2. The MASTER then sends the DIM a Slave Action number as a 24-bit data message.
3. The DIM performs the requested action if appropriate.
4. The DIM responds with an ACK (3 1 0) or NACK (3 1 1) depending on successful completion of the requested action.
The following subnetwork Slave Action command numbers have been implemented in the DIM module and will be acknowledged. All others will be rejected.
N = 00:00:80H Save Energy Loads the present counter values, counter status, and digital inputs for the addressed channel into a buffer to be read by the Transmit Saved Counter Values (3 D 1)(3 C E) subnetwork command.
N = 00:04:nnH Reset Inactivity Bit nn = 00H:Reset the channel’s Inactivity Flag and timer if the flag had been set.
nn = 01H: Reset the channel’s Inactivity Flag and timer (regardless of the status of the channel’s Inactivity Flag).
N = 03:00:06H Acknowledge Energy Reset Clears the counter reset flag in the counter status byte for the addressed channel.
507-46 INCOM System Communications, June 2004
Communication Protocol for the Digital Input Module (DIM)
Save Energy Broadcast Command (D 0 0) This is a broadcast command; it has no response. When the (D 0 0) command is received, the DIM loads the present counter values, present counter status, and present digital input states for all 4 channels into a buffer to be read by the Transmit Saved Counter Values subnetwork command (3 D 1)(3 C E).
INCOM System Communications, June 2004 507-47
Communication Protocol for the Digital Input Module (DIM)
CHANGE RECORD
Revision Date Changes 0.00 05/03/99 Working development document. No revision control other than date.
0.10 05/10/99 One tamper bit for each channel
0.20 10/22/01 Revised per code revisions. All sections essentially rewritten.
1.0 11-06-01 Initial Release
2.0 11/26/02 Revised per Plug n' Play Version 1.03
3.0 1-23-03 Updated commands 3CF. 38A and 3D1/38A to latest PnP ver. 1.03
507-48 INCOM System Communications, June 2004