System Sensor FAAST XT ModBus Schema 11 User guide

Type
User guide
FAAST Fire Alarm Aspiration Sensing
Technology
®
Modbus Protocol Schema 11
USER GUIDE
User Guide: FAAST Fire Alarm Aspiration Sensing Technology
®
Modbus Protocol Schema 11
2
User Guide: FAAST Fire Alarm Aspiration Sensing Technology
®
Modbus Protocol Schema 11
3
Rev C
Table of Contents
Revision Table ...................................................................................................................................4
List of Tables .....................................................................................................................................4
Product Description .........................................................................................................................5
Communication Interface ................................................................................................................6
Ethernet ..............................................................................................................................................................................................6
RS-485 .................................................................................................................................................................................................6
Modbus Resources ............................................................................................................................................................................7
Client Interface ..................................................................................................................................7
Accessible Registers .........................................................................................................................................................................7
Data Format ........................................................................................................................................................................................7
Device Sensor Status and Control Operations ..............................................................................8
Modbus Administration Password ...................................................................................................................................................8
Device Read ........................................................................................................................................................................................8
Device Output and Operating Mode Control ...................................................................................................................................8
Device Con guration .........................................................................................................................................................................8
Device Time ........................................................................................................................................................................................9
Device Smoke Reference ..................................................................................................................................................................9
Reading Logs .....................................................................................................................................................................................9
Trend Log Read ................................................................................................................................................................................10
Message Log Read ..........................................................................................................................................................................10
Input Registers................................................................................................................................ 11
Holding Registers ........................................................................................................................... 11
Sensor Status ...................................................................................................................................................................................12
Device Status ...................................................................................................................................................................................15
Device Logs ......................................................................................................................................................................................16
Factory Con guration ......................................................................................................................................................................18
Modbus Con guration .....................................................................................................................................................................18
Device Functions and Sensor Inputs .............................................................................................................................................19
Device Con guration .......................................................................................................................................................................20
General Con guration .....................................................................................................................................................................22
Network Con guration ....................................................................................................................................................................23
User Interface Con guration...........................................................................................................................................................24
Appendix A. Con guration Options on FAAST ............................................................................25
A.1. Alarm Con guration Variables .................................................................................................................................................25
A.2. Device Con guration Variables ...............................................................................................................................................27
User Guide: FAAST Fire Alarm Aspiration Sensing Technology
®
Modbus Protocol Schema 11
4
Revision Table
Revision Description of Change Author Date
A Initial Release ZK 8-Aug-2014
B Added XM. Updated sensitivity limits ZK 30-Oct-2015
C Added FAAST XT Pro ZK 1-Jun-2016
List of Tables
Table 1. MODBUS over RS-485 Con guration ................................................................................................................................7
Table 2. MODBUS Input Registers ..................................................................................................................................................11
Table 3. Holding Register Banks ..................................................................................................................................................... 11
Table 4. Sensor Status MODBUS Holding Registers ...................................................................................................................12
Table 5. Device Status MODBUS Holding Registers ....................................................................................................................15
Table 6. Device Log MODBUS Holding Registers ........................................................................................................................16
Table 7. Factory Con guration MODBUS Holding Registers .......................................................................................................18
Table 8. MODBUS Con guration Holding Registers .....................................................................................................................18
Table 9. MODBUS Speci c con guration Holding Registers .......................................................................................................19
Table 10. Device Con guration MODBUS Holding Registers ......................................................................................................20
Table 11. General Con guration MODBUS Holding Registers .....................................................................................................22
Table 12. Network Con guration MODBUS Holding Registers ...................................................................................................23
Table 13. UI Con guration MODBUS Holding Registers ..............................................................................................................24
Table 14. Alarm Con guration Variable Ranges ...........................................................................................................................25
Table 15. Device Con guration Variable Ranges ..........................................................................................................................27
User Guide: FAAST Fire Alarm Aspiration Sensing Technology
®
Modbus Protocol Schema 11
5
Rev C
Product Description
The FAAST Fire Alarm Aspiration Sensing Technology
®
aspirating smoke detector is an advanced particulate detection system
designed for use in early warning and very early warning fi re detection applications. FAAST draws air from the environment through
sampling holes in a pipe network and monitors for smoke particulates. FAAST includes a local display that provides a clear indication
of the device status. Smoke particulate level, alarm level, air fl ow and faults can all be discerned with a glance at the user interface.
One Protocol interface comprises of the MODBUS over TCP server. The physical interface is Ethernet. A TCP server listens on Port
502. Separate ports provide connections to the E-mail, PipeIQ protocol server and a web server. This enables access to all servers
simultaneously through individual TCP sockets.
FAAST also supports MODBUS over RS-485 when connected to 2-wire or 4-wire systems. Either MODBUS/TCP or MODBUS/RS-485
can be used at any one time. The MODBUS confi guration settings can be set with Pipe IQ
TM
tool.
FAAST product variants function differently from model to model. Please refer to the installation instructions of the relevant products
for which the MODBUS Protocol interface will be implemented. i.e. Verify the confi guration methods available for the product under
consideration and the behavior in response to each operating mode.
MODBUS is a communications protocol allowing for connectivity with several building management solutions. Using MODBUS, a
FAAST device can be monitored remotely and various device confi guration actions and device interactions are facilitated.
This FAAST Modbus user guide and memory map is provided to assist users who want to interface with FAAST devices using
Modbus. Please note that:-
· Provision of this guide and memory map is not recommendation to use or an endorsement of using a Modbus interface. Honeywell
does not accept responsibility for any Modbus interface or for the operation of any FAAST device using a Modbus interface. The
interface is used entirely at the user’s own risk.
· If Modbus is used to set confi gurations on a FAAST device, the design must be verifi ed using PipeIQTM to ensure that site specifi c
requirements are met.
· If Modbus is used to modify any installed FAAST device, any changes to sensitivity settings must be verifi ed in PipeIQTM to ensure
continued system performance.
User Guide: FAAST Fire Alarm Aspiration Sensing Technology
®
Modbus Protocol Schema 11
6
Communication Interface
Ethernet
The MODBUS protocol stack is an application that runs over TCP. The device requires a 10 or 100Mbps Ethernet connection to an
existing IP network and a valid network confi guration in order to enable MODBUS Communications. The FAAST device’s TCP server
will listen for MODBUS protocol packets on Port 502. Separate TCP ports allow MODBUS, e-mail, PipeIQ
TM
and web communications
simultaneously. Finally, to transmit and receive data over MODBUS, the user requires a client that can generate MODBUS packets
over TCP. The Device Identifi er is the only confi guration option. The range is 1-247.
RS-485
The FAAST XT and XS detectors support MODBUS over RS-485 in both RTU and ASCII formats. The table below lists the confi guration
options. FAAST XM does not support RS-485 natively. The products support 4-wire RS-485 by default. TX and RX terminals must
be shorted together to support two-wire RS-485. A 120 ohm terminating resistor is in every installation kit. It may be used at the RX
terminals for the last device on a loop to improve signal integrity.
In FAAST XT, the RS-485 terminals are biased such that the ‘B’ terminals can be considered ‘-’ (inverting) and the ‘A’ terminals are
considered ‘+‘ (non-inverting).
In FAAST XT, the RS-485 terminals are labeled ‘-’ and ‘+‘ for inverting and non-inverting terminals respectively.
The following reference schematics show the connections required to connect FAAST XT and XS devices to a B&B Electronics
Isolated USB to RS422/485 Converter (Model USOPTL4) in both full and half duplex modes. Actual terminal connections may vary
for different converters.
FAAST XT Connected in Full Duplex
FAAST XS Connected in Full Duplex FAAST XS Connected in Half Duplex
FAAST XT Connected in Half Duplex
User Guide: FAAST Fire Alarm Aspiration Sensing Technology
®
Modbus Protocol Schema 11
7
Rev C
Criteria RTU ASCII
Device Identifi er 1-247 1-247
Baud rate (bps) 1200, 9600, 14400, 19200, 28800, 57600, 115200 1200, 9600, 14400, 19200, 28800, 57600, 115200
Data bits 8 7,8
Stop bits 1,2 1,2
Parity None, Even, Odd None, Even, Odd
Table 1. Modbus Over RS-485 Confi guration
Modbus Resources
1. MODBUS Application Protocol Specifi cation, Version 1.1b3, Modbus Organization, Hopkinton, MA, 2012
2. MODBUS over Serial Line Specifi cation and Implementation Guide, Version 1.02, Modbus Organization, Hopkinton, MA, 2006
3. MODBUS Messaging on TCP/IP Implementation Guide, Version 1.0b, Modbus Organization, Hopkinton, MA, 2006
4. T. Kugelstadt, “The RS-485 Design Guide”, Texas Instruments, Dallas, TX, Application Report SLA272B, May 2008
5. User Guide: FAAST Networking, System Sensor, Saint Charles, IL, 2012
Client Interface
Accessible Registers
Input registers for registers listed in Table 1. Holding registers in tables following.
Data Format
To transfer data to and from the MODBUS registers, the following descriptions specify how data is organized when more than one
register is required to read or write a specifi c piece of data.
1. Long Integer, fl oating point:
Value = 0xaabbccdd
Holding Reg1 = 0xaabb
Holding Reg2 = 0xccdd
2. String:
Value = “test”
Holding Reg1 = “et”
Holding Reg2 = “ts”
3. IP Address:
Value = a.b.c.d
Holding Reg1 = dc
Holding Reg2 = ba
4. MAC Address:
Value = 0x (aa-bb-cc-dd-ee-ff)
Holding Reg1 = 0xbbaa
Holding Reg2 = 0xddcc
Holding Reg3 = 0xffee
User Guide: FAAST Fire Alarm Aspiration Sensing Technology
®
Modbus Protocol Schema 11
8
Device Sensor Status and Control Operations
Modbus Administrator Password
The MODBUS Administrator Password grants the user the privilege of writing to the Holding Registers. This password is set in the
MODBUS Confi guration using PipeIQ
TM
. It is not readable through the MODBUS Interface. It is set to ‘1111’ as the default. The values
may range from 0001 to 9999.
A failure to gain administrator privileges due to a forgotten or lost password is recoverable by using the PipeIQ
TM
software, connecting
to the device and updating the device confi guration with a known password.
Device Read
The MODBUS client is able to read the device status data directly via input and holding register reads.
A failure to gain administrator privileges due to a forgotten or lost password is a recoverable event by using the PipeIQ
TM
software,
connecting to the device and updating the device confi guration with a known password.
Device Output and Operating Mode Control
The MODBUS client is able to initiate different operating modes through the Sensor Input Holding Register.
1. Write the Administrator Password in the Administrator Password holding register (this is can be confi gured through PipeIQ
TM
).
2. Read the Sensor API status holding register and verify that the ADMIN_UNLOCK bit is set.
3. Write the value to the Sensor Input Holding Register (40035) that initiates the desired action or mode change:
a. 0x0001 to Isolate
b. 0x0002 to Disable
c. 0x0004 to Reset the Device
d. 0x0008 to Initiate Test
e. 0x0010 to Reset the Airfl ow Baseline
f. 0x0020 to Silence a Fault or Alarm (when equipped with an audible indicator)
g. 0x0040 to Reset the Network Settings to Factory Default
h. 0x0080 to Clear the Event Log
i. 0x0100 to Clear the Message Log
4. Write 0x0 to the Administrator Password in the Administrator Password holding register if no further changes are desired.
Device Con guration
In order to write a new confi guration, the following steps must be followed:
1. Write the Administrator Password in the Administrator Password holding register.
2. Read the Sensor API status holding register and verify that the ADMIN_UNLOCK bit is set. If it is set, the Sensor API
Command Register is enabled and will process commands issued.
3. The device must be placed in Disable Mode by setting disable bit in Sensor Input Holding register.
4. Read the Operating Mode holding register to verify the device is in Disable Mode.
5. The MODBUS client writes the new values for the respective confi guration holding registers through Write Multiple Register
Command(s).
6. Write the Save Confi guration Command value, 0xAA11 in the MODBUS Specifi c confi guration Command holding register
in order to save any confi guration changes.
7. The device stores new confi guration. The current RTC value will be stored into time of last confi guration registers.
8. Read the MODBUS Specifi c confi guration Command holding register. The value will be 0x0000 when the Command
completes successfully.
9. The device will reset if the confi guration is valid.
10. Remove the device from Disable Mode by clearing the disable bit in Sensor Input Holding register.
11. The device will reset and the new confi guration will be applied.
User Guide: FAAST Fire Alarm Aspiration Sensing Technology
®
Modbus Protocol Schema 11
9
Rev C
Device Time
In order to set the time, the following steps must be followed:
1. Write the Administrator Password in the Administrator Password holding register
2. Read the Sensor API status holding register and verify that the ADMIN_UNLOCK bit is set. If it is set, the Sensor API
Command Register is enabled and will process commands issued.
3. The MODBUS client writes the new time value using Epoch/UNIX timestamp format to the time holding registers through Write
Multiple Register Command(s).
4. Write the Save Time Command value, 0xEE22 in the MODBUS Specifi c confi guration Command holding register in order
to save the new time.
5. The device stores and applies the new time.
6. Read the MODBUS Specifi c confi guration Command holding register. The value will be 0x0000 when the Command
completes successfully.
7. Write 0x0 to the Administrator Password in the Administrator Password holding register if no further changes are desired.
Device Smoke Reference
The device may be programmed with a reference in order to compensate for a period of high particulate due to a change in ambient
environmental conditions. Use the following steps to modify the Device Reference:
1. Write the Administrator Password in the Administrator Password holding register
2. Read the Sensor API status holding register and verify that the ADMIN_UNLOCK bit is set. If it is set, the Sensor API
Command Register is enabled and will process commands issued.
3. The MODBUS client writes the new Reference Value in 32-bit Float format to the Smoke Reference Value register through
Write Multiple Register Command.
4. The device applies the new Reference.
5. Read the Sensor Smoke Reference Value to verify it stored correctly.
6. Write 0x0 to the Administrator Password in the Administrator Password holding register if no further changes are desired.
Reading Logs
In order to read the device logs, the following steps must be followed.
Event Log Read
1. Write the Administrator Password in the Administrator Password holding register.
2. Read the Sensor API status holding register and verify that the ADMIN_UNLOCK bit is set.
3. Write the Event log index value into corresponding holding register using Write Single Holding Register Command (0x06).
The default shall be 1 which reads the latest 40 events.
4. Read Event Logs.
Examples:
a. Total no. of events = 50, Index = 2, then the Event log read command will read last 10 events.
b. Total no. of events = 80, Index = 2, then the Event log read command will read last 40 events.
c. Total no. of events <= 80, Index = 3, then the client shall show Device read failure because there are
no events present in the memory corresponding to given Index value.
User Guide: FAAST Fire Alarm Aspiration Sensing Technology
®
Modbus Protocol Schema 11
10
Trend Log Read
1. Write the Administrator Password in the Administrator Password holding register.
2. Read the Sensor API status holding register and verify that the ADMIN_UNLOCK bit is set.
3. Write the Trend log index value into corresponding holding register using Write Single Holding Register Command (0x06).
The default shall be 1 which reads the latest one trend log.
4. Read the Trend Log.
Examples:
a. Total no. of trends = 50, Index = 2, then the Trend log read command will read recent but one trend log.
b. Total no. of trends = 80, Index = 80, then the Trend log read command will read last trend log.
c. Total no. of trends = 30, Index >30, then the client shall show Device read failure because there are
no trends present in the memory corresponding to given Index value.
Message Log Read
1. Write the Administrator Password in the Administrator Password holding register.
2. Read the Sensor API status holding register and verify that the ADMIN_UNLOCK bit is set.
3. Write the Message log index value into corresponding holding register using Write Single Holding Register Command (0x06).
The default shall be 1 which reads the latest one message log.
4. Read the Message Log
Examples:
a. Total no. of messages = 50, Index = 2, then the Message log read command will read recent but one message log.
b. Total no. of messages = 20, Index = 20, then the Message log read command will read last message log.
c. Total no. of messages = 30, Index >30, then the client shall show Device read failure because there are
no messages present in the memory corresponding to given Index value.
User Guide: FAAST Fire Alarm Aspiration Sensing Technology
®
Modbus Protocol Schema 11
11
Rev C
Input Registers
Note: The MODBUS Holding Register addresses are indexed for a Honeywell Building Solutions Enterprise Building Integrator
TM
client. Other clients may need to subtract 1 from each address in order to access the desired register.
Address Size (16-
bit words)
Parameter Name Type Description
30001 1 Schema U16 Modbus Firmware Schema for client to determine version of register mapping.
Table 2. Modbus Input Registers
Holding Registers
Note: The MODBUS Holding Register addresses are indexed for a Honeywell Building Solutions Enterprise Building Integrator
TM
client. Other clients may need to subtract 1 from each address in order to access the desired register.
The Holding registers are categorized as banks to support forward compatibility. In each bank there are register addresses reserved
for future. The device will give zeros with error status when user tries to access these reserved registers. Following table specifi es
the register bank details.
S. No Bank Name Register Address Range Reserved Address Range
1 Sensor Status 40001-40074 40075-40400
2 Device Status 40401-40417 40418-40800
3 Factory Confi guration 40801-40817 40818-41200
4 MODBUS Confi guration 41201-41207 41208-41600
5 Device Logs 41601-41856 41857-42000
6 Device Functions and Sensor Inputs 42001-42010 42011-42400
7 Device Confi guration 42401-42481 42482-42800
8 General Confi guration 42801-42932 42933-43200
9 Network Confi guration 43201-43426 43427-43600
10 User Interface Confi guration 43601-43610 43611-44000
Table 3. Holding Register Banks
User Guide: FAAST Fire Alarm Aspiration Sensing Technology
®
Modbus Protocol Schema 11
12
Sensor Status
The device’s Sensor Status register map is READ ONLY and mapped directly to a set of holding registers. The registers are defi ned
as follows:
Address Size
(16-bit
words)
Parameter Name Type Description
40001-2 2 Universal Time Stamp U32 Read Only - Universal Time Stamp corresponding to the real-time clock
value in UNIX seconds epoch format
3 1 Operating Mode U16 Device Operating Mode Enumeration:
CONFIGURATION_MODE=0,
INITIALIZATION_MODE,
TEST_MODE,
NORMAL_MODE,
DISABLE_MODE,
RESET_MODE,
FACTORY_MODE,
SERVICE_MODE,
ISOLATE_NEW_MODE,
RESET_NETWORK_MODE,
FIRMWARE_UPGRADE_MODE (not available in XM),
NETWORK_FIRMWARE_UPGRADE_MODE (not available in XM)
4-5 2
Δ Current Photo Signal F32 Current Photo value in the device
(%/ft if US Standard or %/m if metric)
6-7 2 Δ Photo Signal Min F32 Minimum Obscuration Level the Smoke Sensor Detected (frequency
depends on trend write frequency confi guration)
8-9 2 Δ Photo Signal Max F32 Maximum Obscuration Level the Smoke Sensor Detected (frequency
depends on trend write frequency confi guration)
10-11 2 Δ Alert Threshold F32 Current Active Alert Threshold (%/ft if US Standard or %/m if metric)
12-13 2 Δ Action1 Threshold F32 Current Active Action1 Threshold
(%/ft if US Standard or %/m if metric)
14-15 2 Δ Action2 Threshold F32 Current Active Action2 Threshold
(%/ft if US Standard or %/m if metric)
16-17 2 Δ Fire1 Threshold F32 Current Active Fire1 Threshold (%/ft if US Standard or %/m if metric)
18-19 2 Δ Fire2 Threshold F32 Current Active Fire2 Threshold (%/ft if US Standard or %/m if metric)
20-21 2 Δ Smoke Reference Value F32 Current smoke reference value in the device
(%/ft if US Standard or %/m if metric)
22 ½ Alarm Level U8 Alarm Status
Bit 0: Alert
Bit 1: Action1 (ignore in XS)
Bit 2: Action2 (ignore in XS)
Bit 3: Fire1
Bit 4: Fire2
Bits 5-7 unused.
23 ½ Relay Status U8 Relay Status.
Bit 0: Alert
Bit 1: Action1 (not used in XS)
Bit 2: Action2 (not used in XS)
Bit 3: Fire1
Bit 4: Fire2
Bit 5: Minor Fault (General Fault for SLC equipped models)
Bit 6: Isolate (if equipped)
Bit7: Urgent Fault (if equipped)
24-25 2
Δ Chamber Flow F32 Current Chamber fl ow value (%/ft if US Standard or %/m if metric)
26-27 2 Δ Chamber Baseline Flow F32 Current Chamber Baseline fl ow value
(%/ft if US Standard or %/m if metric)
User Guide: FAAST Fire Alarm Aspiration Sensing Technology
®
Modbus Protocol Schema 11
13
Rev C
Sensor Status (cont.)
Address Size
(16-bit
words)
Parameter Name Type Description
28-29 2 Δ Chamber Flow Min F32 Minimum Chamber fl ow (time depends on trend frequency confi guration)
30-31 2 Δ Chamber Flow Max F32 Maximum Chamber fl ow (time depends on trend frequency confi guration)
32-33 2
Δ Inlet 1 Flow F32 Current Inlet 1 fl ow value (%/ft if US Standard or %/m if metric)
34-35 2 Δ Inlet 1 Baseline Flow F32 Current Inlet 1 Baseline fl ow value (%/ft if US Standard or %/m if metric)
36-37 2 Δ Inlet 1 Flow Min F32 Minimum Inlet 1 fl ow (time depends on trend frequency confi guration )
38-39 2 Δ Inlet 1 Flow Max F32 Maximum Inlet 1 fl ow (time depends on trend frequency confi guration )
40-41 2 Δ Inlet 2 Flow F32 Current Inlet 2 fl ow value (%/ft if US Standard or %/m if metric)
42-43 2 Δ Inlet 2 Baseline Flow F32 Current Inlet 2 Baseline fl ow value (%/ft if US Standard or %/m if metric)
44-45 2 Δ Inlet 2 Flow Min F32 Minimum Inlet 2 fl ow (time depends on trend frequency confi guration )
46-47 2 Δ Inlet 2 Flow Max F32 Maximum Inlet 2 fl ow (time depends on trend frequency confi guration )
48-49 2 Δ Inlet 3 Flow F32 Current Inlet 3 fl ow value (%/ft if US Standard or %/m if metric)
50-51 2 Δ Inlet 3 Baseline Flow F32 Current Inlet 3 Baseline fl ow value (%/ft if US Standard or %/m if metric)
52-53 2
Δ Inlet 3 Flow Min F32 Minimum Inlet 3 fl ow (time depends on trend frequency confi guration )
54-55 2 Δ Inlet 3 Flow Max F32 Maximum Inlet 3 fl ow (time depends on trend frequency confi guration )
56-57 2 Δ Inlet 4 Flow F32 Current Inlet 4 fl ow value ( %/ft if US Standard or %/m if metric)
58-59 2 Δ Inlet 4 Baseline Flow F32 Current Inlet 4 Baseline fl ow value (%/ft if US Standard or %/m if metric)
60-61 2 Δ Inlet 4 Flow Min F32 Minimum Inlet 4 fl ow (time depends on trend frequency confi guration )
62-63 2 Δ Inlet 4 Flow Max F32 Maximum Inlet 4 fl ow (time depends on trend frequency confi guration )
64 ½ Air Flow Boundary U8 Confi gured percentage Flow boundary limit in the device
65 ½ Air Flow Delay U8 Confi gured Fault timer delay in the device
66 1 Temperature S16 Chamber Current Temperature in Celsius
67 1 Fan Speed U16 Current Fan Speed in RPMs
68 1 System Faults U16 System Faults
Bit 0: Low Voltage
Bit 1: Confi guration
Bit 2: Sensor
Bit 3: External Monitor
Bit 4: Time
Bit 5: Communication
Bit 6: Aspirator
Bit 7: Filter
Bit 8: Isolation
Bit 9: Disable
Bit 10: Comms Confi guration
Bit 11: MOS Sensor (XT Pro only)
Bits 12-15: Unused
69 ½ System Flow Faults U8 System Flow Faults
Bit 0: Low Flow Inlet 1
Bit 1: Low Flow Inlet 2
Bit 2: Low Flow Inlet 3
Bit 3: Low Flow Inlet 4
Bit 4: High Flow Inlet 1
Bit 5: High Flow Inlet 2
Bit 6: High Flow Inlet 3
Bit 7: High Flow Inlet 4
User Guide: FAAST Fire Alarm Aspiration Sensing Technology
®
Modbus Protocol Schema 11
14
Sensor Status (cont.)
Address Size
(16-bit
words)
Parameter Name Type Description
70 ½ Loop Number U8 SLC Eclipse Loop value
71 ½ Address Number U8 SLC Address value
72 ½ Base line BOOL Base lining status.
1 = Baselining
0 = Baseline process complete
73 ½ Inlet Enable/Disable U8 Flow Inlets Enable/Disable Status (XT ONLY)
1 = Enabled, 0 = Disabled
Bit 0: Inlet 1
Bit 1: Inlet 2
Bit 2: Inlet 3
Bit 3: Inlet 4
74 ½ Fan Speed Level U8 Confi gured Fan Speed Level of the device. 0-low, 1-meduim, 2-high
(XT and XS ONLY)
75 ½ MOS Status U8 MOS Status (XT Pro Only)
Bit 0: Unused
Bit 1: MOS Installed status (1 = installed, 0 = not installed)
Bit 2: MOS Enabled status (1 = enabled, 0 = disabled)
Bit 3: MOS Backup sensor status (1 = backup active, 0 = primary active)
Bit 4: Unused
Bit 5-7: Smoke Inlet Number (0 = no inlet identifi ed, 1 = inlet 1,
2 = inlet 2, 3 = inlet 3, 4 = inlet 4)
76-400 1 Reserved Registers
Table 4. Sensor Status Modbus Holding Registers
Δ Warning!! Device threshold con guration variables should be set by the user to values scaled based on the Units
con guration setting. The detector will interpret the value differently for different Units settings. E.g. The device will interpret a
0.01 threshold setting as 0.01 %/ft when Units setting is US Standard. The device will interpret a 0.01 threshold setting as 0.01
%/m when Units setting is Metric. XS and XM do not utilize inlets 2-4. Chamber  ow does not apply for XM.
User Guide: FAAST Fire Alarm Aspiration Sensing Technology
®
Modbus Protocol Schema 11
15
Rev C
Device Status
The device’s Device Status register map is READ ONLY with the exception of the Smoke Reference Value and mapped directly to a
set of holding registers. The structure in the Firmware is defi ned as follows:
Address Size
(16-bit
words)
Parameter Name Type Description
40401 1 Trend Capacity Days U16 Indicates how many days of trend data that device can store in the
device
402 ½ Trend Capacity Hours U8 Indicates how many Hours of trend data that device can store in the
device(apart from no. of days)
403-404 2 Lifetime Count in Days U32 Days of operation during lifetime
405-407 3 Lockout Functions U8[3]
XT and XS
User Interface Lockout
B0 = Confi guration
B1 = LCD Settings
B2 = Functions
XM
User Interface Lockout
B0 = Test
B1 = Reset (or Mode for Intelligent Devices)
B2 = Isolate (and subsequently the Disable function from the buttons)
408 1 Device Status Bits U16 Bit 0 – MODBUS Admin Unlock
1 = Unlocked, 0 = Locked
Bit 1 – Sounder On/Off
1 = On, 0=Off
409 ½ u8CommsMajorVerNo U8
XT and XS
Comms Processor Firmware Major Version Number
XM only
Application Firmware Revision
410 ½ u8CommsMinorVerNo U8
XT and XS Only
Comms Processor Firmware Minor Version Number
411 ½ u8SensorMajorVerNo U8
XT and XS Only
Sensor Processor Firmware Major Version Number
412 ½ u8SensorMinorVerNo U8
XT and XS Only
Sensor Processor Firmware Minor Version Number
413 1 u16CurrentMODBUSCmd U16 Current MODBUS Specifi c Command Status
0xFFFF = Default value
0x0000 = Operation is Complete
414 ½ u8CommsBootMajorVerNo U8
XT and XS Only
Comms Processor Boot Loader Firmware Major Version Number
XM only
Bootloader Firmware Revision
415 ½ u8CommsBootMinorVerNo U8
XT and XS Only
Comms Processor Boot Loader Firmware Minor Version Number
416 ½ u8SensorBootMajorVerNo U8
XT and XS Only
Sensor Processor Boot Loader Firmware Major Version Number
417 ½ u8SensorBootMinorVerNo U8
XT and XS Only
Sensor Processor Boot Loader Firmware Minor Version Number
418-800 1 Reserved Registers
Table 5. Device Status Modbus Holding Registers
User Guide: FAAST Fire Alarm Aspiration Sensing Technology
®
Modbus Protocol Schema 11
16
Device Logs
The device’s Log Structure is READ ONLY and mapped directly to a set of holding registers. The registers are defi ned as follows:
Address Size
(16-bit
words)
Parameter Name Type Description
41601 1 Event Log Entries U16 Number of Event Log Entries
1602 1 Trend Log Entries U16 Number of Trend Log Entries
1603 1 Message Log Entries U16 Number of Message Log Entries
1604-1723 3 x 40 Read Event Log U32
U16
Reads 40 log entries starting with the entry in the Index register.
Each entry contains a 32-bit time stamp and 16-bit Event number
Confi guration Mode = 0,
Initialization = 1,
Test Mode = 2,
Normal Mode = 3,
Disable Mode = 4,
Reset Mode = 5,
Reserved, Internal Use Only = 6,
Service Mode = 7,
Isolate Mode = 8,
Reset Network Confi guration = 9,
Firmware Upgrade = 10,
Network Firmware Upgrade = 11,
Alarm Alert = 12,
Alarm Action 1 = 13,
Alarm Action 2 = 14,
Alarm Fire 1 = 15,
Alarm Fire 2 = 16,
Low Voltage Fault = 17,
Confi guration Fault = 18,
Sensor Fault = 19,
External Device Fault = 20,
Time Fault = 21,
Communication Fault = 22,
Aspirator Fault = 23,
Filter Fault = 24,
Flow Fault Low Inlet 1 = 25,
Flow Fault Low Inlet 2 = 26,
Flow Fault Low Inlet 3 = 27,
Flow Fault Low Inlet 4= 28,
Flow Fault High Inlet 1= 29,
Flow Fault High Inlet 2= 30,
Flow Fault High Inlet 3= 31,
Flow Fault High Inlet 4= 32,
Confi guration Change Success = 33,
UI Unlock Failed = 34,
Sounder Silenced =35,
POR Comms = 36,
POR IP Reset = 37,
POR Sensor = 38,
POR SLC = 39,
POR External Monitor Short = 40,
POR Service Exit = 41,
POR Disable Exit = 42,
POR Reset Command = 43,
POR = 44,
Reset Baselines = 45,
POR Comms SLC IP Reset = 46,
MOS_SENSOR_BACKUP_ACTIVATION = 47, (XT Pro only)
MOS_SENSOR_FAILED=48, (XT Pro only)
ALERT inlet not determined = 49 (XT Pro only),
ALERT inlet 1 = 50 (XT Pro only),
ALERT inlet 2 = 51 (XT Pro only),
ALERT inlet 3 = 52 (XT Pro only),
ALERT inlet 4 = 53 (XT Pro only),
ACTION1 inlet not determined = 54 (XT Pro only),
ACTION1 inlet 1 = 55 (XT Pro only),
ACTION1 inlet 2 = 56 (XT Pro only),
ACTION1 inlet 3 = 57 (XT Pro only),
ACTION1 inlet 4 = 58 (XT Pro only),
ACTION2 inlet not determined = 59 (XT Pro only),
ACTION2 inlet 1 = 60 (XT Pro only),
ACTION2 inlet 2 = 61 (XT Pro only),
ACTION2 inlet 3 = 62 (XT Pro only),
ACTION2 inlet 4 = 63 (XT Pro only),
FIRE1 inlet not determined = 64 (XT Pro only),
FIRE1 inlet 1 = 65 (XT Pro only),
FIRE1 inlet 2 = 66 (XT Pro only),
FIRE1 inlet 3 = 67 (XT Pro only),
FIRE1 inlet 4 = 68 (XT Pro only),
FIRE2 inlet not determined = 69 (XT Pro only),
FIRE2 inlet 1 = 70 (XT Pro only),
FIRE2 inlet 2 = 71 (XT Pro only),
FIRE2 inlet 3 = 72 (XT Pro only),
FIRE2 inlet 4 = 73 (XT Pro only)
User Guide: FAAST Fire Alarm Aspiration Sensing Technology
®
Modbus Protocol Schema 11
17
Rev C
Device Logs (cont.)
Address Size
(16-bit
words)
Parameter Name Type Description
1724-1754 31 Δ Read Trend Log U32
F32[8]
U8[10]
S16[2]
U16
Reads log entry specifi ed by the Index register.
XT and XS
Each entry contains a 32-bit time stamp and (Trend frequency
confi gured time) air velocity and smoke detection logs as follows:
Float : Alert Threshold
Float : Action1 Threshold
Float : Action2 Threshold
Float : Fire1 Threshold
Float : Fire2 Threshold
UINT8: Flow Percentage Change Minimum
UINT8: Flow Percentage Change Minimum (inlets 1-4)
UINT8: Flow Percentage Change Maximum
UINT8: Flow Percentage Change Maximum (inlets 1-4)
Float : Photo Signal Avg
Float : Photo Signal Max
Float : Photo Signal Min
SINT16 : Temperature Minimum
SINT16 : Temperature Maximum
UINT16 : Fan Speed RPM
XM
Each entry contains a 32-bit time stamp and (Trend frequency
confi gured time) air velocity and smoke detection logs as follows:
Float : Alert Threshold
Float : Action1 Threshold
Float : Action2 Threshold
Float : Fire1 Threshold
Float : Fire2 Threshold
UINT8: Always 0
UINT8: Flow Percentage Change Minimum (inlet 1, next 3 bytes 0)
UINT8: Always 0
UINT8: Flow Percentage Change Maximum (inlet 1, next 3 bytes 0)
Float : Photo Signal Avg
Float : Photo Signal Max
Float : Photo Signal Min
SINT16 : Temperature Minimum
SINT16 : Temperature Maximum
UINT16 : Fan Speed RPM
1755-1856 102 Message Log U32
U16[100]
Reads the log entry specifi ed by the Index register.
Each entry contains a 32-bit time stamp and a UTF-16 100 character string.
1857-2000 1 Reserved Registers
Table 6. Device Log Modbus Holding Registers
User Guide: FAAST Fire Alarm Aspiration Sensing Technology
®
Modbus Protocol Schema 11
18
Modbus Con guration
The device’s MODBUS Confi guration register map is READ ONLY and mapped directly to a set of holding registers. The registers
are defi ned as follows:
Address Size (16-bit words) Parameter Name Type Description
41201 1/2 MODBUS Interface type BOOL 1=RS-485, 0=TCP
XM will always return 0, TCP only
1202 1 MODBUS_SERIAL_MODE U16 MODBUS Serial Transmission Mode
RTU=0,
ASCII=1
XM will always return 0, TCP only
1203 1/2 u8ModbusUniqueIdentifi er U8 MODBUS Unique Identifi er
1204 1 MODBUS_SERIAL_BAUD_RATE U16 MODBUS Serial Transmission Baudrate
BR_1200=0,
BR_9600=1,
BR_14400=2,
BR_19200=3,
BR_28800=4,
BR_57600=5,
BR_115200=6
XM will always return 0, TCP only
1205 1/2 u8DataBits U8 MODBUS Serial Data bits
XM will always return 0, TCP only
1206 1/2 u8StopBits U8 MODBUS Serial Stop bits
XM will always return 0, TCP only
1207 1 MODBUS_SERIAL_PARITY U16 MODBUS Serial Transmission Parity type
PARITY_NONE=0,
PARITY_ODD=1,
PARITY_EVEN=2
XM will always return 0, TCP only
1208-1600 1 Reserved Registers
Table 8. Modbus Confi guration Holding Registers
Factory Con guration
The device’s Factory Confi guration register map is READ ONLY and mapped directly to a set of holding registers. The registers are
defi ned as follows:
Address Size
(16-bit
words)
Parameter Name Type Description
40801-802 2 Mfg Time Stamp U32 Manufacturing Time Stamp – UNIX seconds since epoch format
803 1 SLC_PROTOCOL_TYPE U16 Defi nes the supported SLC protocol:
CONVENTIONAL = 0, CLIP, FLASHSCAN, ECLIPSE, ADVANCED,
PROTOCOL_OTHER
804-806 3 MAC Address U8[6]
XT and XS only
Device’s MAC Address
807-816 10 Model Number U8[20] Model Number of the Device
817 1 OEMID_TYPE U16 NOTIFIER=0,
FIRELITE, FIKE, JOHNSON_CONTROLS, HONEYWELL, ADT, FCI,
GAMEWELL, SILENT_KNIGHT, MIRCOM, SYSTEM_SENSOR=10,
SYSTEM_SENSOR_CHINA=11,
FAAST=12
818-1200 1 Reserved Registers
Table 7. Factory Confi guration Modbus Holding Registers
User Guide: FAAST Fire Alarm Aspiration Sensing Technology
®
Modbus Protocol Schema 11
19
Rev C
Device Functions and Sensor Inputs
The device function and sensor inputs are WRITE ONLY and mapped directly to a set of holding registers. The registers are defi ned
as follows:
Address Size
(16-bit
words)
Parameter Name Type Description
42001 1 Δ Administrator Password U16 Password to enable Commands through the Command holding
register
Enter as an Unsigned Decimal number.
2002 1
Δ Sensor Command
Register
U16 Command Register: 0xAA11 – Save Confi guration
0xEE22 – Save Time
2003 1 Δ Event Log Index U16 Starting Index of Event Log Entry to read
2004 1 Δ Trend Log Index U16 Starting Index of Trend Log to read
2005 1 Δ Message Log Index U16 Starting Index of Message Log to read
2006 1 Δ Sensor Inputs U16
XT and XS ONLY
B0: ISOLATE
B1: DISABLE
B2: RESET
B3: TEST
B4: RESET BASELINES
B5: SOUNDER SILENCE
B6: RESET IP CONFIGURATION
B7: CLEAR EVENT LOG
B8: CLEAR MESSAGE LOG
B9-15: UNUSED
XM ONLY
B0: ISOLATE
B1: DISABLE
B2: RESET
B3: TEST
B4: RESET BASELINES
B5: SOUNDER SILENCE
B6: UNUSED
B7: UNUSED
B8: CLEAR EVENT LOG
B9: CLEAR MESSAGE LOG
B10-15: UNUSED
2007-2008 2 Δ Smoke Reference Value F32 Smoke Reference value to the sensor
2009-2010 2 Set Time U32 Set Time in UNIX seconds epoch format
2011-2400 1 Reserved Registers
Table 9. Modbus Specifi c Confi guration Holding Registers
Δ Information - Registers 4201-4206 can be con gured by using Function code 6 (single write) or Function 16 (multiple write).
Δ Warning!! Device threshold con guration variables should be set by the user to values scaled based on the Units
con guration setting. The detector will interpret the value differently for different Units settings. E.g. The device
will interpret a 0.01 threshold setting as 0.01 %/ft when Units setting is US Standard. The device will interpret a
0.01 threshold setting as 0.01 %/m when Units setting is Metric.
User Guide: FAAST Fire Alarm Aspiration Sensing Technology
®
Modbus Protocol Schema 11
20
Device Con guration
The device’s Device Confi guration register map is READ - WRITE and mapped directly to a set of holding registers. The registers are
defi ned as follows:
Address Size
(16-bit
words)
Parameter Name Type Description
42401-2402 2 Confi g Timestamp U32 Epoch time of last confi guration
2403 1 Δ Units U16 Units of Measure for Alarm Threshold Obscuration Values
Metric 0
US Standard 1
2404 ½ Alert Delay U8 Alert Alarm Delay in Seconds
2405 ½ Action1 Delay U8 Action1 Alarm Delay in Seconds
2406 ½ Action2 Delay U8 Action2 Alarm Delay in Seconds
2407 ½ Fire1 Delay U8 Fire1 Alarm Delay in Seconds
2408 ½ Fire2 Delay U8 Fire2 Alarm Delay in Seconds
2409 ½ Relays Latching U8 Set latching behavior of minor fault and alarms.
Non-latching 0
Latching 1
Bit 0: Alert
Bit1: Action1
Bit2: Action2
Bit3: Fire1
Bit4: Fire2
Bit5: Minor
2410 ½ Detection Mode U8 Detection Mode and MOS Sensor Confi guration
Bit 0: Detection Mode*
Bits 1-4:Not Used
Bit 5: MOS Confi guration Enable/Disable
Bits6-7: Not used
* - Detection Mode
0 = Fixed (Use Fixed Alarm Thresholds)
1 = Acclimate (Use Acclimate Alarm Thresholds)
2411-2412 2 Day Time Start U32 UNIX Epoch Local Time Stamp to mark the time in which to
use the day alarm thresholds.
2413-2414 2 Night Time Start U32 UNIX Epoch Local Time Stamp to mark the time in which to
use the night alarm thresholds.
2415 ½ DST Enable/Disable BOOL Day light savings Enable bit
1=Enable, 0=Disable
2416-2417 2 Day of week U8[2] 0 = Sunday
1 = Monday
6 = Saturday
2418-2419 2 Nth Occurrence of Day in Month U8[2] 0 = 1st, 1 = 2nd, 2 = 3rd, 3 = last
2420-2421 2 Month U8[2] 0 = January
1 = February
11 = December
2422-2423 2 Hour U8[2] 0 -23
2424-2425 2 Minute U8[2] 0 - 59
2426 1 Seconds U16 0 - 59
2427-2428 2
Δ Alert Day Threshold F32 Alert Alarm Day Obscuration Threshold
2429-2430 2 Δ Alert Night Threshold F32 Alert Alarm Night Obscuration Threshold
2431-2432 2 Δ Alert Weekend Threshold F32 Alert Alarm Weekend Obscuration Threshold
2433-2434 2
Δ Action1 Day Threshold F32 Action1 Alarm Day Obscuration Threshold
2435-2436 2 Δ Action1 Night Threshold F32 Action1 Alarm Night Obscuration Threshold
2437-2438 2 Δ Action1 Weekend Threshold F32 Action1 Alarm Weekend Obscuration Threshold
  • Page 1 1
  • Page 2 2
  • Page 3 3
  • Page 4 4
  • Page 5 5
  • Page 6 6
  • Page 7 7
  • Page 8 8
  • Page 9 9
  • Page 10 10
  • Page 11 11
  • Page 12 12
  • Page 13 13
  • Page 14 14
  • Page 15 15
  • Page 16 16
  • Page 17 17
  • Page 18 18
  • Page 19 19
  • Page 20 20
  • Page 21 21
  • Page 22 22
  • Page 23 23
  • Page 24 24
  • Page 25 25
  • Page 26 26
  • Page 27 27
  • Page 28 28

System Sensor FAAST XT ModBus Schema 11 User guide

Type
User guide

Ask a question and I''ll find the answer in the document

Finding information in a document is now easier with AI