NK8237 MP4.
Table of Contents About this document.........................................................................................................5 1 Safety regulations ..............................................................................................8 1.1 Country-specific standards...................................................................................8 1.2 Assembly and installation.....................................................................................8 1.
About this document About this document Purpose This manual is intended as a guide to the Modbus interface provided by the NK823x Gateway for the fire control units of FS20/FS720/STT20 families. The manual presents the application-level information of this interface indicating the fire objects mapping, and describes the corresponding Modbus registry structure and the applicable Modbus functions.
About this document 3. In the resulting area on the right, click on Contents link to show the list of search results. For more information such as Siemens news and announcements, visit the STEP Web portal at: https://workspace.sbt.siemens.com/content/00001123/default.aspx Operational and safety regulations Before groups of persons begin work on the system, they must have read and understood the Safety Regulations [➙ 8] section in this manual.
About this document Menu paths are indicated in bold. Select File > Text, Copy > Group, which means from the File menu, then select Text, Copy and finally Group. Error and system messages are displayed in The message Definition Courier New font. successfully renamed displays in the status bar. Italics are used to emphasize a term. The Open Processor continuously executes a user-defined set of instructions called the control program. This symbol signifies a Note.
1 Safety regulations Country-specific standards 1 Safety regulations This section describes the danger levels and the relevant safety regulations applicable to the use of the products described in this manual. Please read the following work instructions as well as the preceding section About this document thoroughly before beginning any work. 1.1 Country-specific standards Siemens products are developed and produced in compliance with the relevant international and European safety standards.
Safety regulations Modifications to system design and products 1.5 1 Modifications to system design and products Modifications to a system or to individual products may cause faults or malfunctioning. Please request written approval from Siemens Building Technologies, FS-DMS, and the relevant authorities concerning intended system modifications and system extensions. 9 Building Technologies Fire Safety & Security Products A6V10316242_a_en 30.06.
2 Modbus Interface Specifications Modbus Gateway 2 Modbus Interface Specifications The Modbus gateway enables Modbus master/client stations to access the FS20/FS720/STT20 fire control units for acquiring the status information. The gateway also allows for control commands to be transmitted from the Modbus master/client stations to the fire system. A specific agreement with Siemens is required for this type of functions.
Modbus Interface Specifications Modbus Data Model 2.2 Applicable table types 2 Function code Function Notes 0x04 Read Input Registers Summary; Status; Compact Status Use it for reading status information 0x06 Write Single Register Command; Synchronization Use it for writing command registers, to perform control actions, and date & time registers, thus synchronizing the NK8237 clock.
2 Modbus Interface Specifications Modbus Data Model Once finalized, the CSV file can be used for integrating the model information in the Modbus master/client station, and the corresponding register map downloaded into the NK823x unit. Note: All addressing starts with offset 0. 2.2.1.1 Customizing Modbus Maps The following illustrates the overall map customization procedure. 1. Start the Composer tool and open the Modbus gateway project. The project tree displays in the Composer environment. 2.
Modbus Interface Specifications Modbus Data Model 2 Feeding the fire system configuration into the Modbus master/client configuration tool. The following fields (columns) are present in the CSV file: SubsystemId Identifier of the subsystem in the Composer project, and used during file re-import. It cannot be modified. NodeId Identifier of the node in the Composer project, and used during file re-import. It cannot be modified.
2 Modbus Interface Specifications Modbus Data Model CommandRange Starting address of the set of Modbus Holding Registers associated to the command objects. Modifications to this field are ignored in the re-import. Note however that the base addresses for the command tables can be modified in the Composer configuration. For each object, the actual Modbus register address is determined by summing the Modbus BaseAddress and the ModbusAddress. ModbusAddress Object offset address.
Modbus Interface Specifications Modbus Data Model 2 Status tables These are word input registers reporting the conditions of all the mapped objects. Each word corresponds with one object and is organized in two bytes: bits 0-7 are used to represent the object operating modes, for example the on/off (inclusion/exclusion) conditions, whereas bits 8-15 contain the abnormal event conditions, such as alarms, fault, and so on.
2 Modbus Interface Specifications Modbus Data Model Command tables The output command tables (read/write holding registers) enables Modbus master/client stations to initiate control commands to the fire control panels. Note that, depending on a configuration setting, certain commands may not be available.
Modbus Interface Specifications Modbus Data Model 2.2.2.2 2 Bit Information Notes about the conditions corresponding to the “1” state (bit active) 6 Control off / test One or more control devices have been excluded or set in test mode 7 Detection off / test One or more detection devices have been excluded or set in test mode 8 Emergency power Due to missing or faulty mains supply, the panel is operating in battery mode.
2 Modbus Interface Specifications Modbus Data Model corresponds with the registers 0 to 124, the second flag corresponds with the registers 125 to 249, and so on. Active flags are automatically reset upon reading the registers that changed and caused the flags activation.
Modbus Interface Specifications Modbus Data Model 2.2.2.3 2 Status Tables The status tables include an input word register per object. The number of tables depends on the specific systems whose object list is defined at configuration time. For example, there may be 8 area registers corresponding with 8 areas of a given fire system.
2 Modbus Interface Specifications Modbus Data Model Bit Information Notes 8 Non-default value Abnormal condition such as zone not ready or other states resulting in a reduced safety 9-13 - Not used 14 Pre-alarm Pre-alarmed * 15 Alarm Alarmed * * If the Channel Delegation option is configured, the Pre-alarm and Alarm events are on the element level (not the Zone level).
Modbus Interface Specifications Modbus Data Model 2 Control element (control channel) WT_CtrlChan (Input registers, default base address: 4800) Bit Information Notes 0 (lsb) Non-default mode Abnormal mode 1-5 - Not used 6 Test Set in test mode 7 Off Excluded 8 Non-default value Abnormal condition resulting in a reduced safety 9-10 - Not used 11 Test active Activated for test 12 - Not used 13 Fault Faulty 14 - Not used 15 Alarm Activated / Alarmed Hardware object WT_HWOb
2 Modbus Interface Specifications Modbus Data Model Unidentified Event WT_Unidentified (Input register, default base address: 7000) 2.2.2.
Modbus Interface Specifications Modbus Data Model 2 The table below collects the list of bit status tables.
2 Modbus Interface Specifications Modbus Data Model 2.2.2.6 Command Tables The command tables enable the Modbus master/client to issue control commands to the fire units. A read/write holding register is foreseen for each of the objects listed below. Given an initial object state, a data value corresponding to a control action can be written in the register to trigger the command that is then expected to modify the object state and therefore cause a corresponding change in the object input registers.
Modbus Interface Specifications Modbus Data Model 2 Detection element (logical channel) on/off: include/exclude the detector CMDT_LogChan (Holding register, default base address 27000) State Command (dec) New state after a successful command execution Off 5 On On 6 Off Control on/off: include/exclude the actuation group CMDT_Ctrl (Holding register, default base address 28000) State Command (dec) New state after a successful command execution Off 5 On On 6 Off Control element (control cha
2 Modbus Interface Specifications Modbus Data Model Modbus Table Modbus Base Address Offset Register WT_Zone 1500 2 Input register WT_LogChan 2500 0 Input register WT_LogChan 2500 1 Input register WT_Ctrl 3500 0 Input register WT_Ctrl 3500 1 Input register WT_CtrlChan 4800 0 Input register WT_Section 6100 0 Input register WT_Section 6100 1 Input register WT_Area 6500 0 Input register WT_HWObj 6601 0 Input register WT_NK8237Point 8000 0 Input register WT_Powe
Modbus Interface Specifications Modbus Data Model Modbus Table Modbus Base Address Offset Register BT_EmergencyPower 33000 0 Discrete input CMDT_FC20 25000 0 Holding register CMDT_Zone 26000 0 Holding register CMDT_LogChan 27000 0 Holding register CMDT_Ctrl 28000 0 Holding register CMDT_CtrlChan 29000 0 Holding register CMDT_Section 30000 0 Holding register CMDT_Area 31000 0 Holding register 2 Panel map: default base address of the available tables, organized by object
2 Modbus Interface Specifications Modbus Data Model Cerberus PRO™ FS720: FC722 FC724 FC726 FT724 WT_Zone Automatic Zone Single Alarm Subsystem zone Single Exting discharged zone Single extinguishing prealarm zone Single gas alarm zone Single gas warning zone Multiple automatic zone (Holland) sprinkler zone Multi Dependency Zone Sprinkler Zone Manual FSE Zone Manual Zone Manual alarm sub-system zone Manual Redundancy Alarm Technical
Modbus Interface Specifications Modbus Data Model 2 ChannelLogInputSubsystemAlarmElem; ChannelLogInputSubsystemFaultElem; ChannelLogInputSubsystemIsolatedElem) Fsd InputLogChannel Fsd Output LogChannel Led Output Release Output channel WT_Ctrl Evac Control Evac Unit Control Fire Control Alarm Control RtDevice Control RtFault Control RtFire Control RtSounder Control Counter Control Alarm Uga Elem Control (ConfigUgaElem) Generic Sounders Releasi
2 Modbus Interface Specifications Modbus Data Model Module IO Module Vds Module P2 Module FCI Module Collective Module Ethernet Module MS9 ModuleReleasing Module CPU Module Rt Card Legacy Field Bus Modules Legacy Modules Lines Sub-Modules: Submodule P2 Element Submodule Communication Submodule Degrade Element Submodule License Element Submodule Collective Submodule Ms9 Submodule Nac Submodule Firmware Devices: 2.2.
Modbus Interface Specifications Modbus Data Model 2 Fire Control Unit Representation In the Modbus data representation, each panel is mapped as a separate Modbus device with an individual address. The device address is defined at configuration time. A dedicated register sub-map is used for each panel, including six types of tables. Namely: Summary tables These are a set of word input registers including: – The overall panel conditions (1 word register).
2 Modbus Interface Specifications Modbus Data Model – Elements Bit status tables For extremely simple applications, a set of bit input registers is also provided for specific objects and events that are combined in very basic 1-bit (on/off) status report.
Modbus Interface Specifications Modbus Data Model 2.2.3.1 2 Summary Table The Summary table includes one register. STT20 synthesis WT_STT20 Syn (Input register, default base address: 1000) One input (read-only) word register reporting 16 general on/off panel conditions in the 16 bits. The following relationship applies: 2.2.3.
2 Modbus Interface Specifications Modbus Data Model The counter stops being incremented if any of these events occurs: The communication between the NK823x gateway and the Modbus unit goes down (this event can be detected and treated by other Modbus units). The communication between the NK823x gateway and the fire panel goes down.
Modbus Interface Specifications Modbus Data Model 2 The three 16-bit registers are organized in 6 byte containing 6 hexadecimal values corresponding with day, month, year, hour, minute, and second, respectively. Word / Bit Information Notes 0 / 0-7 Day 1-31 code in hexadecimal, e.g. 1B hex for day 27.
2 Modbus Interface Specifications Modbus Data Model Bit Information Notes 9-11 - Not used 12 Anomaly STT20 in mixed mode 13 Fault STT20 in manual mode 14-15 - Not used Buzzer WT_Buzzer (Input registers, default base address: 1400) Bit Information Notes 0 (lsb) Non-default mode Abnormal mode resulting in a reduced safety 1-7 - Not used 8 Non-default value Abnormal condition resulting in a reduced safety 9-14 - Not used 15 Active Communication Link (SafeDlink, Cerloop)ù WT_ C
Modbus Interface Specifications Modbus Data Model 2 MEA – Module Electronique Adressable (addressable field control module) WT_MEA (Input registers, default base address: 1700) Bit Information Notes 0 (lsb) Non-default mode Abnormal mode resulting in a reduced safety 1-7 - Not used 8 Non-default value Abnormal condition resulting in a reduced safety 9-12 - Not used 13 Fault 14-15 - Not used MDHW – Matériel Déporté (Remote Module Hardware) WT_MDHW (Input registers, default base address:
2 Modbus Interface Specifications Modbus Data Model Bit Information Notes 13 Fault Battery fault (on MC20, MCO, or MD20 modules) or battery element faulty 14-15 - Not used MCIO – MC20 Input/Output WT_MCIO (Input registers, default base address: 3500) Bit Information Notes 0 (lsb) Non-default mode Abnormal mode resulting in a reduced safety 1-7 - Not used 8 Non-default value Abnormal condition resulting in a reduced safety 9-14 - Not used 15 Active Input or Output is active MDIO
Modbus Interface Specifications Modbus Data Model 2 Extinguishing Function WT_ExtFunction (Input registers, default base address: 6000) Bit Information Notes 0 (lsb) Non-default mode Abnormal mode resulting in a reduced safety 1-7 - Not used 8 Non-default value Abnormal condition resulting in a reduced safety 9-11 - Not used 12 System fault Extinguishing fault report 13 Fault 14-15 - Not used UGA – Unité de Gestion d’Alarme (evacuation control unit) WT_UGA (Input register, default b
2 Modbus Interface Specifications Modbus Data Model Bit Information Notes 7 Disabled 8 Non-default value Disabled 9-15 - Not used Element – Standard / Power supply elements WT_Element (Input registers, default base address: 8200) Bit Information Notes 0 (lsb) Non-default mode Abnormal mode resulting in a reduced safety 1-7 - Not used 8 Non-default value Abnormal condition resulting in a reduced safety 9-11 - Not used 12 Wait position failed Wait position fault 13 Fault 14 I
Modbus Interface Specifications Modbus Data Model 2.2.3.4 2 Compact Status Tables The compact tables provide a summarized representation for the following objects: Functions: 4-bit status representation Elements: 2-bit status representation The corresponding data structures, illustrated here below, are packed in the register areas defined at configuration time. The word input registers contain 4 zones and 8 elements each.
2 Modbus Interface Specifications Modbus Data Model Table Information Related object type Default base address BT_ Mains Fault Mains 14000 BT_ Battery Fault Battery 15000 BT_ Function Safety Position Function 16000 BT_ Function In Command Function 17000 BT_ Function Wait Position Failed Function 18000 BT_ Function Fault Function 19000 BT_ UGA Alarm Evacuation Control 20000 Failed Unit BT_ UGA Activated Evacuation Evacuation Control 21000 Unit BT_ UGA Fault Evacuation Control
Modbus Interface Specifications Modbus Data Model 2 Function Function Active (Holding register, default base address 27000) State Command (dec) New state after a successful command execution Quiet 1 Function activated BOP/HLB Alarm Function Alarm Function Activate Evac (Holding register, default base address 28000) 2.2.3.
2 Modbus Interface Specifications Modbus Data Model Modbus Table Modbus Base Address Offset Register WT_CommunicationLink 1500 0 Input register WT_CommunicationLink 1500 1 Input register WT_HWLink 1600 0 Input register WT_Mea 1700 0 Input register WT_Mea 1700 1 Input register WT_MDHW 1800 0 Input register WT_MDHW 1800 1 Input register WT_MDHW 1800 2 Input register WT_Mains 1900 0 Input register WT_Mains 1900 1 Input register WT_Battery 2500 0 Input register
Modbus Interface Specifications Modbus Data Model 2 Modbus Table Modbus Base Address Offset Register WT_Element 8200 2 Input register WT_ExtElement 9200 0 Input register STT20 map: default base address of the available tables, organized by object type Note: The default base addresses listed above may not exactly match the addressed of your system. Before using them for any related configuration, please check the actual settings of the Modbus master station in the Composer tool.
2 Modbus Interface Specifications Modbus Data Model Bit Information Notes 7 Tamper disabled Tamper detection disabled Note: this information is only available on the tamper register. 8 Non-default value Currently note used (foreseen for future extensions) 9 Abnormal Configuration mismatch between gateway and fire system Note: this information is only available on the NK823x status register.
Issued by Siemens Switzerland Ltd Infrastructure & Cities Sector Building Technologies Division International Headquarters Gubelstrasse 22 CH-6301 Zug Tel. +41 41-724 24 24 www.siemens.com/buildingtechnologies Document ID A6V10316242_a_en Edition 30.06.2013 © 2013 Copyright Siemens Switzerland Ltd Technical specifications and availability subject to change without notice.