faast xt fire alarm aspiration sensing technology modbus ...€¦ · user guide: faast xt fire...

FAAST XT Fire Alarm Aspiration Sensing Technology® Modbus Protocol Schema 10

USER GUIDE

User Guide: FAAST XT Fire Alarm Aspiration Sensing Technology® Modbus Protocol Schema 10

2


3 Rev A2

Table of ContentsProduct Description .........................................................................................................................4Communication Interface ................................................................................................................4

Ethernet ..............................................................................................................................................................................................4

RS-485 .................................................................................................................................................................................................4

Modbus Resources ............................................................................................................................................................................5

Client Interface ..................................................................................................................................5Accessible Registers .........................................................................................................................................................................5

Data Format ........................................................................................................................................................................................5

Device Sensor Status and Control Operations ..............................................................................6Modbus Administration Password ...................................................................................................................................................6

Device Read ........................................................................................................................................................................................6

Device Output and Operating Mode Control ...................................................................................................................................6

Device Configuration .........................................................................................................................................................................6

Device Time ........................................................................................................................................................................................7

Device Smoke Reference ..................................................................................................................................................................7

Reading Logs .....................................................................................................................................................................................7

Trend Log Read ..................................................................................................................................................................................8

Message Log Read ............................................................................................................................................................................8

Input Registers..................................................................................................................................9Holding Registers .............................................................................................................................9Sensor Status ................................................................................................................................. 10Device Status ..................................................................................................................................13Device Logs ....................................................................................................................................14Factory Configuration ....................................................................................................................15Modbus Configuration ...................................................................................................................16Device Functions and Sensor Inputs ............................................................................................17Device Configuration .....................................................................................................................17General Configuration ....................................................................................................................20Network Configuration ...................................................................................................................21User Interface Configuration .........................................................................................................22Appendix A. Configuration Options on FAAST ............................................................................23

A.1. Alarm Configuration Variables .................................................................................................................................................23

A.2. Device Configuration Variables ...............................................................................................................................................25

Revision Table

Revision Description of Change Author Date

A Initial Release ZK 10/30/14


4

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 fire 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 flow and faults can all be discerned with a glance at the user interface.One MODBUS 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 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 full or half duplex. Either MODBUS/TCP or MODBUS/RS-485 can be used at any one time. The MODBUS configuration settings can be set with Pipe IQ 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 configuration 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 configuration actions and device interactions are facilitated.

PLEASE NOTE: WHILE MODBUS CAN BE USED TO SET DEVICE CONFIGURATIONS, THE DESIGN OF ANY NEW FAAST DEVICE MUST BE VERIFIED USING PipeIQ TO ENSURE THAT SITE SPECIFIC REQUIREMENTS ARE MET. IF MODBUS IS USED TO MODIFY AN INSTALLED UNIT, ANY CHANGES TO SENSITIVITY SETTING MUST ALSO BE VERIFIED IN PipeIQTM TO ENSURE CONTINUED SYSTEM PERFORMANCE.

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 configuration 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 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 Identifier is the only configuration option. The valid range is 1-247. This is independent of any other address setting associated with the unit (i.e. SLC address/Device Identifier, IP address, etc).

RS-485

The FAAST detector supports MODBUS over RS-485 (as defined in MODBUS over Serial Line Specification and Implementation Guide V1.02) in both RTU and ASCII formats. The table below lists the configuration options.The RS-485 terminals are biased such that the ‘B’ terminals can be considered ‘+’ and the ‘A’ terminals are considered ‘-‘.

Criteria RTU ASCII

Device Identifier 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 Configuration


5 Rev A

Modbus Resources

1. Modbus Application Protocol Specification, Version 1.1b3, Modbus Organization, Hopkinton, MA, 2012

2. Modbus over Serial Line Specification 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 specific piece of data.

1. Long Integer, floating 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


6

Device Sensor Status and Control Operations

Modbus Administration Password

The Mobus Administrator Password grants the user the privilege of writing to the Holding Registers. This password is set in the Modbus Configuration using PipeIQ. 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 PipeIQTM software, connecting to the device and updating the device configuration 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 software, connecting to the device and updating the device configuration 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 configured through PipeIQ).

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 Airflow 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 Configuration

In order to write a new configuration, 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 configuration holding registers through Write Multiple Register Command(s).

6. Write the Save Configuration Command value, 0xAA11 in the MODBUS Specific configuration Command holding register in order to save any configuration changes.

7. The device stores new configuration. The current RTC value will be stored into time of last configuration registers.

8. Read the MODBUS Specific configuration Command holding register. The value will be 0x0000 when the Command completes successfully.

9. The device will reset if the configuration 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 configuration will be applied.


7 Rev A

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


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 Specific configuration Command holding register in order to save the new time.

5. The device stores and applies the new time.

6. Read the MODBUS Specific configuration Command holding register. The value will be 0x0000 when the Command completes successfully.


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


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.


Reading Logs

In order to read the device logs, the following steps must be followed.

Event Log Read



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.


8

Trend Log Read



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



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.


9 Rev A

Input Registers

The MODBUS Holding Register addresses are indexed for a Honeywell Building Solutions Enterprise Building IntegratorTM 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 IntegratorTM 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 specifies 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 Configuration 40801-40817 40818-41200

4 MODBUS Configuration 41201-41207 41208-41600

5 Device Logs 41601-41856 41857-42000

6 Device Functions and Sensor Inputs 42001-42010 42011-42400

7 Device Configuration 42401-42481 42482-42800

8 General Configuration 42801-42932 42933-43200

9 Network Configuration 43201-43426 43427-43600

10 User Interface Configuration 43601-43610 43611-44000

Table 3. Holding Register Banks


10

Sensor Status

The device’s Sensor Status register map is READ ONLY and mapped directly to a set of holding registers. The registers are defined as follows:



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, NETWORK_FIRMWARE_UPGRADE_MODE

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 configuration)

8-9 2 ∆ Photo Signal Max F32 Maximum Obscuration Level the Smoke Sensor Detected (frequency depends on trend write frequency configuration)

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: AlertBit 1: Action1Bit 2: Action2Bit 3: Fire1Bit 4: Fire2Bits 5-7 unused.

23 ½ Relay Status U8 Relay Status.

Bit 0: AlertBit 1: Action1Bit 2: Action2Bit 3: Fire1Bit 4: Fire2Bit 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 flow value (%/ft if US Standard or %/m if metric)

26-27 2 ∆ Chamber Baseline Flow F32 Current Chamber Baseline flow value (%/ft if US Standard or %/m if metric)


11 Rev A

Sensor Status (cont.)



28-29 2 ∆ Chamber Flow Min F32 Minimum Chamber flow (time depends on trend frequency configuration)

30-31 2 ∆ Chamber Flow Max F32 Maximum Chamber flow (time depends on trend frequency configuration)

32-33 2 ∆ Inlet 1 Flow F32 Current Inlet 1 flow value (%/ft if US Standard or %/m if metric)

34-35 2 ∆ Inlet 1 Baseline Flow F32 Current Inlet 1 Baseline flow value (%/ft if US Standard or %/m if metric)

36-37 2 ∆ Inlet 1 Flow Min F32 Minimum Inlet 1 flow (time depends on trend frequency configuration )

38-39 2 ∆ Inlet 1 Flow Max F32 Maximum Inlet 1 flow (time depends on trend frequency configuration )









56-57 2 ∆ Inlet 4 Flow F32 Current Inlet 4 flow value ( %/ft if US Standard or %/m if metric)




64 ½ Air Flow Boundary U8 Configured percentage Flow boundary limit in the device

65 ½ Air Flow Delay U8 Configured 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 VoltageBit 1: Configuration Bit 2: SensorBit 3: External MonitorBit 4: TimeBit 5: CommunicationBit 6: AspiratorBit 7: FilterBit 8: IsolationBit 9: DisableBit 10: Comms ConfigurationBits 11-15 unused

69 ½ System Flow Faults U8 System Flow Faults

Bit 0: Low Flow Channel 1Bit 1: Low Flow Channel 2Bit 2: Low Flow Channel 3Bit 3: Low Flow Channel 4Bit 4: High Flow Channel 1Bit 5: High Flow Channel 1Bit 6: High Flow Channel 1Bit 7: High Flow Channel 1


12

Sensor Status (cont.)



70 ½ Loop Number U8 SLC Eclipse Loop value

71 ½ Address Number U8 SLC Address value

72 ½ Base line BOOL Base lining status. 1 = Baselining0 = Baseline process complete

73 ½ Inlet Enable/Disable U8 Flow Inlets Enable/Disable Status

1 = Enabled, 0 = DisabledBit 0: Channel 1Bit 1: Channel 2Bit 2: Channel 3Bit 3: Channel 4

74 ½ Fan Speed Level U8 Configured Fan Speed Level of the device. 0-low, 1-meduim, 2-high

75-400 1 Reserved Registers

Table 4. Sensor Status Modbus Holding Registers

∆ Warning!! Device threshold configuration variables should be set by the user to values scaled based on the Units configuration 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.


13 Rev A

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 defined as follows:



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] User Interface LockoutB0 = ConfigurationB1 = LCD SettingsB2 = Functions

408 1 Device Status Bits U16 Bit 0 – MODBUS Admin Unlock 1 = Unlocked, 0 = LockedBit 1 – Sounder On/Off 1 = On, 0=Off

409 ½ u8CommsMajorVerNo U8 Comms Processor Firmware Major Version Number

410 ½ u8CommsMinorVerNo U8 Comms Processor Firmware Minor Version Number

411 ½ u8SensorMajorVerNo U8 Sensor Processor Firmware Major Version Number

412 ½ u8SensorMinorVerNo U8 Sensor Processor Firmware Minor Version Number

413 1 u16CurrentMODBUSCmd U16 Current MODBUS Specific Command Status 0xFFFF = Default value 0x0000 = Operation is Complete

414 ½ u8CommsBootMajorVerNo U8 Comms Processor Boot Loader Firmware Major Version Number

415 ½ u8CommsBootMinorVerNo U8 Comms Processor Boot Loader Firmware Minor Version Number

416 ½ u8SensorBootMajorVerNo U8 Sensor Processor Boot Loader Firmware Major Version Number

417 ½ u8SensorBootMinorVerNo U8 Sensor Processor Boot Loader Firmware Minor Version Number


Table 5. Device Status Modbus Holding Registers


14

Device Logs

The device’s Log Structure is READ ONLY and mapped directly to a set of holding registers. The registers are defined as follows:



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 U32U16

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 Configuration 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 Configuration = 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, Configuration Fault = 18, Sensor Fault = 19, External Device Fault = 20, Time Fault = 21, Communication Fault = 22, Aspirator Fault = 23, Filter Fault = 24, Flow Fault Low Channel 1 = 25, Flow Fault Low Channel 2 = 26, Flow Fault Low Channel 3 = 27, Flow Fault Low Channel 4= 28, Flow Fault High Channel 1= 29, Flow Fault High Channel 2= 30, Flow Fault High Channel 3= 31, Flow Fault High Channel 4= 32, Configuration 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


15 Rev A

Device Logs (cont.)



1724-1754 31 ∆ Read Trend Log U32F32[8]U8[10]S16[2]U16

Reads log entry specified by the Index register.

Each entry contains a 32-bit time stamp and (Trend frequency configured time) air velocity and smoke detection logs as follows:

Float : Alert ThresholdFloat : Action1 ThresholdFloat : Action2 ThresholdFloat : Fire1 ThresholdFloat : Fire2 Threshold

UINT8: Flow Percentage Change Minimum (chamber and 4 inlets)UINT8: Flow Percentage Change Maximum (chamber and 4 inlets)

Float : Photo Signal AvgFloat : Photo Signal MaxFloat : Photo Signal Min

SINT16 : Temperature MinimumSINT16 : Temperature MaximumUINT16 : Fan Speed RPM

1755-1856 102 Message Log U32U16[100]

Reads the log entry specified by the Index register.

Each entry contains a 32-bit time stamp and a UTF-16 100 character string.


Table 6. Device Log Modbus Holding Registers

Factory Configuration

The device’s Factory Configuration register map is READ ONLY and mapped directly to a set of holding registers. The registers are defined as follows:



40801-802 2 Mfg Time Stamp U32 Manufacturing Time Stamp – UNIX seconds since epoch format

803 1 SLC_PROTOCOL_TYPE U16 Defines the supported SLC protocol:CONVENTIONAL = 0, CLIP, FLASHSCAN, ECLIPSE, ADVANCED,PROTOCOL_OTHER

804-806 3 MAC Address U8[6] 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


Table 7. Factory Configuration Modbus Holding Registers


16

Modbus Configuration

The device’s MODBUS Configuration register map is READ ONLY and mapped directly to a set of holding registers. The registers are defined as follows:



41201 1/2 MODBUS Interface type BOOL 1=RS-485, 0=TCP

1202 1 MODBUS_SERIAL_MODE U16 MODBUS Serial Transmission Mode RTU=0, ASCII=1

1203 1/2 u8ModbusUniqueIdentifier U8 MODBUS Unique Identifier

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

1205 1/2 u8DataBits U8 MODBUS Serial Data bits

1206 1/2 u8StopBits U8 MODBUS Serial Stop bits

1207 1 MODBUS_SERIAL_PARITY

U16 MODBUS Serial Transmission Parity type PARITY_NONE=0, PARITY_ODD=1, PARITY_EVEN=2


Table 8. Modbus Configuration Holding Registers


17 Rev A

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 defined as follows:



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 Configuration 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 See union SENSOR_API_INPUTS_UNI for details. Multiple inputs are not allowed.

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


Table 9. Modbus Specific Configuration Holding Registers

∆ Information - Registers 4201-4206 can be configured by using Function code 6 (single write) or Function 16 (multiple write).


Device Configuration

The device’s Device Configuration register map is READ - WRITE and mapped directly to a set of holding registers. The registers are defined as follows:



42401-2402 2 Config Timestamp U32 Epoch time of last configuration

2403 1 ∆ Units U16 Units of Measure for Alarm Threshold Obscuration Values

Metric 0US 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


18

Device Configuration (cont.)



2409 ½ Relays Latching U8 Set latching behavior of minor fault and alarms.

Non-latching 0Latching 1

Bit 0: AlertBit1: Action1Bit2: Action2Bit3: Fire1Bit4: Fire2Bit5: Minor

2410 ½ Detection Mode U8 Detection Mode Fixed 0, (use Fixed Alarm Thresholds)Acclimate 1, (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 bit1=Enable, 0=Disable

2416-2417 2 Day of week U8[2] 0 = Sunday1 = 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 = January1 = 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

2439-2440 2 ∆ Action2 Day Threshold F32 Action2 Alarm Day Obscuration Threshold

2441-2442 2 ∆ Action2 Night Threshold F32 Action2 Alarm Night Obscuration Threshold

2443-2444 2 ∆ Action2 Weekend Threshold

F32 Action2 Alarm Weekend Obscuration Threshold

2445-2446 2 ∆ Fire1 Day Threshold F32 Fire1 Alarm Day Obscuration Threshold

2447-2448 2 ∆ Fire1 Night Threshold F32 Fire1 Alarm Night Obscuration Threshold

2449-2450 2 ∆ Fire1 Weekend Threshold F32 Fire1 Alarm Weekend Obscuration Threshold

2451-2452 2 ∆ Fire2 Day Threshold F32 Fire2 Alarm Day Obscuration Threshold

2453-2454 2 ∆ Fire2 Night Threshold F32 Fire2 Alarm Night Obscuration Threshold


19 Rev A

Device Configuration (cont.)



2455-2456 2 ∆ Fire2 Weekend Threshold

F32 Fire2 Alarm Weekend Obscuration Threshold

2457-2458 2 ∆ Alert Acclimate Threshold Max

F32 Maximum Alert Alarm Threshold when operating in Acclimate Mode

2459-2460 2 ∆ Alert Acclimate Threshold Min

F32 Minimum Alert Alarm Threshold when operating in Acclimate Mode

2461-2462 2 ∆ Action1 Acclimate Threshold Max

F32 Maximum Action1 Alarm Threshold when operating in Acclimate Mode

2463-2464 2 ∆ Action1 Acclimate Threshold Min

F32 Minimum Action1 Alarm Threshold when operating in Acclimate Mode

2465-2466 2 ∆ Action2 Acclimate Threshold Max

F32 Maximum Action2 Alarm Threshold when operating in Acclimate Mode

2467-2468 2 ∆ Action2 Acclimate Threshold Min

F32 Minimum Action2 Alarm Threshold when operating in Acclimate Mode

2469-2470 2 ∆ Fire1 Acclimate Threshold Max

F32 Maximum Fire1 Alarm Threshold when operating in Acclimate Mode

2471-2472 2 ∆ Fire1 Acclimate Threshold Min

F32 Minimum Fire1 Alarm Threshold when operating in Acclimate Mode

2473-2474 2 ∆ Fire2 Acclimate Threshold Max

F32 Maximum Fire2 Alarm Threshold when operating in Acclimate Mode

2475-2476 2 ∆ Fire2 Acclimate Threshold Min

F32 Minimum Fire2 Alarm Threshold when operating in Acclimate Mode

2477 ½ Flow Boundary U8 Flow boundary in %, 0-50%

2478 ½ Flow Delay Timer U8 Fault delay timer value in seconds, 0-255

2479 ½ Inlet Enable/Disable U8 Inlets Enable.Bit value 0 = Disable and 1 = Enable

2480 ½ Fan Speed Level U8 Fan speed level. 0=low, 1=medium, 2=high

2481 ½ ID Number U8 Can be used for the SLC address or an identification number on a loop

Flashscan 1-Address: 1-159Flashscan 5-Address: 1-155CLIP: 1-99Eclipse: 1-255


Table 10. Device Configuration Modbus Holding Registers



20

General Configuration



42801-2832 32 Contact U8[64] UTF-16 Contact Name string buffer

2833-2864 32 Facility U8[64] UTF-16 Facility Name string buffer

865-2896 32 Facility Location U8[64] UTF-16 Facility Location string buffer

2897-2928 32 Device Location U8[64] UTF-16 Device Location string buffer

2929 ½ Time Format U8 Device time format0 = 12 hr1 = 24 hr

2930 1 DST Location U16 Day light savings location0 = US1 = EU2 = Custom

2931 1 Trend Period Units U16 0 = Minutes1 = Hours

2932 ½ Trend Storage Frequency U8 1-60 Minutes or 1-24 Hours


Table 11. General Configuration MODBUS Holding Registers


21 Rev A

Network Configuration

The device’s Network Configuration register map is READ - WRITE and mapped directly to a set of holding registers. The registers are defined as follows:



43201-3216 16 Web Password U8[32] Password for login from web client. Password shall be MD-5 encrypted. WRITE_ONLY

3217-3240 24 E-mail Sender U8[48] UTF-8 E-mail sender account name string buffer

3241-3264 24 E-mail Server U8[48] UTF-8 E-mail outgoing SMTP server name string buffer

3265 1 SMTP Port U16 SMTP Port Address

3266-3289 24 E-mail Recipient #1 U8[48] UTF-8 E-mail address of recipient #1

3290 ½ E-mail Recipient #1 Notifications

U8 Enables for notifications based on type of event. B0 - ISOLATE, 1=Enable, 0=DisableB1 - FAULTS, 1=Enable, 0=DisableB2 - RESERVEDB3 – FIRE2, 1=Enable, 0=DisableB4 – FIRE1, 1=Enable, 0=DisableB5 - ACTION2, 1=Enable, 0=DisableB6 – ACTION1, 1=Enable, 0=DisableB7 - ALERT, 1=Enable, 0=Disable



U8 Enables for notifications based on type of event













3416 ½ Static IP Enable U8 Enable/Disable for Static IP. Disabled state enables DHCP-based IP address assignment. 0 =Disabled, Not zero = Enabled

3417-3418 2 Static IP Address U8[4] Static IP Address

3419-3420 2 Static IP Subnet U8[4] Static IP Subnet Mask

3421-3422 2 Static IP Gateway U8[4] Static IP Gateway

3423-3424 2 Static IP Preferred DNS U8[4] Static IP Preferred DNS Address

3425-3426 2 Static IP Alternate DNS U8[4] Static IP Alternate DNS Address


Table 12. Network Configuration Modbus Holding Registers


22

User Interface Configuration

The device’s UI Configuration register map is READ - WRITE and mapped directly to a set of holding registers. The registers are defined as follows:



43601-3604 ½ UI LCD Lockout Passcode U8[4] UI LCD Lockout Passcode. WRITE-ONLY

3605-3607 3 UI LCD Lockout Configuration

U8[3] UI LCD Lockout Configuration

3608 1 UI Display Language U16 UI Display Language ENGLISH=0, GERMAN, DUTCH, FRENCH, ITALIAN, SPANISH, NORWEGIAN, SWEDISH, FINNISH, HUNGARIAN, RUSSIAN, PORTUGUESE, CHINESE, LANGUAGE_CUSTOM = 13

3609 1 Sounder Fault Tone Type U16] Sounder Fault Tone Type TONE_OFF=0, TONE_PULSED=1, TONE_CONTINUOUS=2

3610 1 Sounder Alarm Tone Type U16 Sounder Alarm Tone Type TONE_OFF=0, TONE_PULSED=1, TONE_CONTINUOUS=2


Table 13. UI Configuration MODBUS Holding Registers


23 Rev A

Appendix A. Configuration Options on FAASTA.1. Alarm Configuration Variables


Name Description Range Default Value

Units

AlertThresholdDay The sensitivity where the Alert Alarm will occur during the daytime. 0.00046 – 6.250.0015 – 20.5

0.0120.0396

%/ft%/m

Action1ThresholdDay The sensitivity where the Action1 Alarm will occur during the daytime. 0.00046 – 6.250.0015 – 20.5

0.050.165

%/ft%/m

Action2ThresholdDay The sensitivity where the Action2 Alarm will occur during the daytime. 0.00046 – 6.250.0015 – 20.5

0.10.33

%/ft%/m

Fire1ThresholdDay The sensitivity where the Fire1 Alarm will occur during the daytime. 0.00046 – 6.250.0015 – 20.5

0.250.825

%/ft%/m

Fire2ThrehsoldDay The sensitivity where the Fire2 Alarm will occur during the daytime. 0.00046 – 6.250.0015 – 20.5

0.51.65

%/ft%/m

AlertThresholdNight The sensitivity where the Alert Alarm will occur during the nighttime. 0.00046 – 6.250.0015 – 20.5

0.0120.0396

%/ft%/m

Action1ThresholdNight The sensitivity where the Action1 Alarm will occur during the nighttime. 0.00046 – 6.250.0015 – 20.5

0.050.165

%/ft%/m

Action2ThresholdNight The sensitivity where the Action2 Alarm will occur during the nighttime. 0.00046 – 6.250.0015 – 20.5

0.10.33

%/ft%/m

Fire1ThresholdNight The sensitivity where the Fire1 Alarm will occur during the nighttime. 0.00046 – 6.250.0015 – 20.5

0.250.825

%/ft%/m

Fire2ThrehsoldNight The sensitivity where the Fire2 Alarm will occur during the nighttime. 0.00046 – 6.250.0015 – 20.5

0.51.65

%/ft%/m

NightTimeEnter Time at which to switch to nighttime thresholds. 6:00 pm Time

NightTimeExit Time at which to switch to daytime thresholds. 6:00 am Time

AlertHigh Sensitive limit for Alert when acclimate mode is active 0.00046 – 6.250.0015 – 20.5

0.001380.00455

%/ft%/m

Action1High Sensitive limit for Action1 when acclimate mode is active 0.00046 – 6.250.0015 – 20.5

0.00280.00924

%/ft%/m

Action2High Sensitive limit for Action2 when acclimate mode is active 0.00046 – 6.250.0015 – 20.5

0.00750.02475

%/ft%/m

Fire1High Sensitive limit for Fire1 when acclimate mode is active 0.00046 – 6.250.0015 – 20.5

0.010.033

%/ft%/m

Fire2High Sensitive limit for Fire2 when acclimate mode is active 0.00046 – 6.250.0015 – 20.5

0.10.33

%/ft%/m

AlertLow Insensitive limit for Alert when acclimate mode is active 0.00046 – 6.250.0015 – 20.5

0.0120.0396

%/ft%/m

Action1Low Insensitive limit for Action1 when acclimate mode is active 0.00046 – 6.250.0015 – 20.5

0.051.65

%/ft%/m

Action2Low Insensitive limit for Action2 when acclimate mode is active 0.00046 – 6.250.0015 – 20.5

0.10.33

%/ft%/m


24

A.1. Alarm Configuration Variables (cont.)


Units

Fire1Low Insensitive limit for Fire1 when acclimate mode is active 0.00046 – 6.250.0015 – 20.5

0.250.825

%/ft%/m

Fire2Low Insensitive limit for Fire2 when acclimate mode is active 0.00046 – 6.250.0015 – 20.5

0.51.65

%/ft%/m

AcclimateAlertLevel Current Sensitivity for Alert Alarm when in acclimate mode. AlertHigh – AlertLow

AlertLow %/ft%/m

AcclimateAction1Level Current Sensitivity for Action1 Alarm when in acclimate mode. Action1High – Action1Low

Action1Low %/ft%/m

AcclimateAction2Level Current Sensitivity for Action2 Alarm when in acclimate mode. Action2High – Action2Low

Action2Low %/ft%/m

AcclimateFire1Level Current Sensitivity for Fire1 Alarm when in acclimate mode. Fire1High – Fire1Low

Fire1Low %/ft%/m

AcclimateFire2Level Current Sensitivity for Fire2 Alarm when in acclimate mode. Fire2High – Fire2Low

Fire2Low %/ft%/m

Table 14. Alarm Configuration Variable Ranges


25 Rev A

A.2. Device Configuration Variables



Acclimate Mode Enable Set to activate acclimate mode operation Enable / Disable Disabled

Alert Alarm Latch Set to latch Alert alarm. Requires a RESET to clear alarm.This setting is only valid for conventional product.

Latching/Non-Latching

Latching

Action1 Alarm Latch Set to latch Action1 alarm. Requires a RESET to clear alarm.This setting is only valid for conventional product.


Latching

Action2 Alarm Latch Set to latch Action2 alarm. Requires a RESET to clear alarm.This setting is only valid for conventional product.


Latching

Fire1 Alarm Latch Set to latch Fire1 alarm. Requires a RESET to clear alarm.This setting is only valid for conventional product.


Latching

Fire2 Alarm Latch Set to latch Fire2 alarm. Requires a RESET to clear alarm.This setting is only valid for conventional product.


Latching

Alert Delay Programmable delay before activating Alert AlarmThis setting is only valid for conventional product.

0 - 60 seconds 0

Action1 Delay Programmable delay before activating Action1 AlarmThis setting is only valid for conventional product.

0 - 60 seconds 0

Action2 Delay Programmable delay before activating Action2 AlarmThis setting is only valid for conventional product.

0 - 60 seconds 0

Fire1 Delay Programmable delay before activating Fire1 AlarmThis setting is only valid for conventional product.

0 - 60 seconds 0

Fire2 Delay Programmable delay before activating Fire2 AlarmThis setting is only valid for conventional product.

0 - 60 seconds 0

LCD UI Lockout Passcode

Allows lockout feature for Functions, Configurations and LCD Setting Menus

0000 - 9999 1111

Functions Menu Setting for locking and unlocking of Functions menu. This setting is only valid for conventional product.

Locked

Configuration Menu Setting for locking and unlocking of Configuration menu. This setting is only valid for conventional product.

Locked

LCD Setting Menu Setting for locking and unlocking of LCD setting menu. This setting is only valid for conventional product.

Locked

IP Address IP address of the device 192.168.1.10

Subnet Mask 255.255.255.0

Gateway 192.168.1.1

Address Device local address range MODBUS CLIP enabled product Flashscan enabled product Eclipse enabled product

1-2471-991-1591-255

1

Time Real time clock time in hours/minutes/seconds Midnight

MODBUS Admin Passcode

Allows write permission from MODBUS 0001 – 9999 1111

MODBUS Unique ID MODBUS unique Identification Number 1-247 1

Date Real time clock date Current date

Year Real time clock year Current year

Password User Password for Web Access User entry Monitor

Table 15. Device Configuration Variable Ranges


26


27 Rev A

User Guide: FAAST Fire Alarm Aspiration Sensing Technology® Modbus Protocol Schema 1

©2014 System Sensor. ASUG61701 • 10/14

User Guide: FAAST XT Fire Alarm Aspiration Sensing Technology® with Modbus Schema 10

faast xt fire alarm aspiration sensing technology modbus ...€¦ · user guide: faast xt fire...

Documents