FieldServer FS-8700-72 Secutron Driver Manual (Supplement to the FieldServer Instruction Manual) APPLICABILITY & EFFECTIVITY Effective for all systems manufactured after November 2015 Kernel Version: 1.02 Document Revision: 2
Contact Information: Thank you for purchasing the FieldServer. Please call us for Technical support of the FieldServer product. Contact Information: Sierra Monitor Corporation 1991 Tarob Court Milpitas, CA 95035 Contact number: +1 408 262-6611 +1 800 727-4377 Email: info@sierramonitor.com Website: www.sierramonitor.com Contact Information
TABLE OF CONTENTS 1 Secutron Modul-R driver Description... 4 2 Driver Scope of Supply... 5 2.1 Supplied by Sierra Monitor Corporation for this driver... 5 3 4 Hardware Connections... 5 Data Array Parameters... 6 5 Configuring the FieldServer as a Secutron Modul-R driver Client... 7 5.1 Client Side Connection Parameters... 7 5.2 Client Side Node Parameters... 8 5.3 Client Side Map Descriptor Parameters... 8 5.3.1 FieldServer Specific Map Descriptor Parameters... 8 5.3.2 Driver Specific Map Descriptor Parameters... 8 5.3.3 Timing Parameters... 8 5.3.4 Map Descriptor Example.... 9 6 Configuring the FieldServer as a Secutron Modul-R driver Server... 10 6.1 Server Side Connection Parameters... 10 6.2 Server Side Node Parameters... 11 6.3 Server Side Map Descriptors... 11 6.3.1 FieldServer Specific Map Descriptor Parameters... 11 6.3.2 Driver Specific Map Descriptor Parameters... 11 6.3.3 Map Descriptor Example.... 12 Appendix A. Troubleshooting... 13 Appendix A.1. Driver Messages, Error Messages and Optional Map Descriptors... 13 Appendix B. Reference... 13 Appendix B.1. Event Function or Condition Codes... 13 Appendix B.2. Panel Circuit or Zone numbers... 14 Appendix B.3. Panel Power-up, Restarts and Resets... 15 LIST OF FIGURES Figure 1 - Generic Connection Diagram... 5 Table of Contents
1 SECUTRON MODUL-R DRIVER DESCRIPTION The Secutron Modul-R driver allows the FieldServer to transfer data to and from a Client and a Server panel on a single point to point network over RS-232 using Secutron Modul-R protocol. The protocol is strictly command/response with the Client polling a Server device. A Server device can report the generation and clearing of alarms to the polling Client. One panel can be connected per FieldServer port. The driver supports networked panels. The Client Drive supports up to 1000 networked panels per port, but the Server driver only supports 10 panels due to memory limitations. A Server panel can consist of up to 100 circuits. When an alarm is generated, a bit is set and when the alarm is cleared, the bit is cleared. The panel number is identified by the Node_ID in the configuration file. Each circuit s alarms are represented by 32 unsigned quantities, which hold 1,024 bits. Only bits 0 to 999 may be used. The last 25 bits are reserved. There are 3200 unsigned quantities per panel to represent the 100 circuits with 1000 devices per circuit. Each bit of the 32-bits in an unsigned quantity represents an alarm state (1 = alarm, 0 = normal). A set bit indicates an alarm and the clearing of a bit indicates the reset of an alarm. A panel number is identified by the Node Id in the configuration files. Panel, circuit and device numbers range from 0 in messages e.g. Panel numbers 0 to 999 Circuit numbers 0 to 99 Device numbers 0 to 999 The Client driver is configured with three Map Descriptors. Each Map Descriptor must be of a certain Secutron_Type. The following types and their functions are defined: Secutron_type Poller Device Function Map Descriptor Function Polls the Secutron Modul-R at the configured scan interval. Stores alarm (Device) statuses. Stores the function or type of alarm that was triggered or restored. The Server driver emulates a Secutron Modul-R panel and is configured through the use of two Map Descriptors: Secutron_type Device Function Map Descriptor Function Stores alarm (Device) statuses. Stores the function or type of alarm that was triggered or restored. The Server driver will respond with alarm statuses from the Device Map Descriptor. The Function Map Descriptor will return the type or function of the corresponding alarm reported by the Device Map Descriptor. Fieldserver Mode Nodes Comments Client Up to 1000 per port Only one panel can be connected per port, but the driver supports up to 1000 networked panels. Server 10 Max of 10 panels supported due to memory limitations. Page 4 of 15
2 DRIVER SCOPE OF SUPPLY 2.1 Supplied by Sierra Monitor Corporation for this driver Sierra Monitor Corporation PART # FS-8917-16 Description Pigtail cable for RJ45 Port 3 HARDWARE CONNECTIONS The FieldServer is connected to the panels as shown below. Configure the panels according to manufacturer s instructions. SECUTRON PANEL Orange/White Blue/white Brown FieldServer Part # 8917-16 Pigtail for RJ45 Port Connect to one of the RS-232 Ports on the FieldServer RJ45 8 1 FieldServer P1 Figure 1 - Generic Connection Diagram Connector Pinouts RJ-45 Pin From RJ-45 To Secutron 1 Brown Tx 8 White/Orange Rx 5 Blue/white GND Page 5 of 15
4 DATA ARRAY PARAMETERS Data Arrays are protocol neutral data buffers for storage of data to be passed between protocols. It is necessary to declare the data format of each of the Data Arrays to facilitate correct storage of the relevant data. Section Title Data_Arrays Up to 15 Data_Array_Name Provide name for Data Array alphanumeric characters Data_Array_Format Provide data format. Each Data Array can only take on one format. BIT, UInt16, Byte. Data_Array_Length Number of Data Objects. Must be larger than the data storage area required by the Map Descriptors for the data being placed in this array. 1-10, 000 Example // Data Arrays Data_Arrays Data_Array_Name, Data_Array_Format, Data_Array_Length p1c1_devices, Bit, 1 p1c1_function, Byte, 1000 p1c69_restart, Bit, 1000 p1c69_function, Byte, 100 p1c90_reset, Bit, 100 p1c90_function, Byte, 100 Page 6 of 15
5 CONFIGURING THE FIELDSERVER AS A SECUTRON MODUL-R DRIVER CLIENT For a detailed discussion on FieldServer configuration, please refer to the FieldServer Configuration Manual. The information that follows describes how to expand upon the factory defaults provided in the configuration files included with the FieldServer (See.csv files on the provided with the FieldServer). This section documents and describes the parameters necessary for configuring the FieldServer to communicate with Secutron Modul-R panels. The configuration file tells the FieldServer about its interfaces, and the routing of data required. In order to enable the FieldServer for Secutron Modul-R driver communications, the driver independent FieldServer buffers need to be declared in the Data Arrays section, the destination device addresses need to be declared in the Client Side Nodes section, and the data required from the Servers needs to be mapped in the Client Side Map Descriptors section. Details on how to do this can be found below. Note that in the tables, * indicates an optional parameter, with the bold legal value being the default. 5.1 Client Side Connection Parameters Section Title Connections Column Title Function Legal Values Port Specify through which port the device is connected to the FieldServer P1-P2 1 Baud* Specify baud rate 150, 300, 1200, 2400, 4800, 9600 (Vendor limitation) Parity* Specify parity None (Vendor limitation) Data_Bits* Specify data bits 8 (Vendor limitation) Stop_Bits* Specify stop bits 1 (Vendor limitation) Protocol Specify protocol used Secutron Example // Client Side Connections Connections Port, Protocol, Baud, Parity P1, Secutron, 9600, None 1 Not all ports shown are necessarily supported by the hardware. Consult the appropriate Instruction manual for details of the ports available on specific hardware. Page 7 of 15
5.2 Client Side Node Parameters Section Title Nodes Node_Name Provide name for Node Node_ID Generic Node ID unique to port. Also used as panel number. 0-999 Protocol Specify protocol used Secutron Port Specify which port the device is connected to the FieldServer P1-P2 1 Example // Client Side Nodes Nodes Node_Name, Node_ID, Protocol, Connection Node_1, 1, Secutron, P1 Up to 32 alphanumeric characters 5.3 Client Side Map Descriptor Parameters 5.3.1 FieldServer Specific Map Descriptor Parameters Map_Descriptor_Name Name of this Map Descriptor Up to 32 alphanumeric characters Data_Array_Name Name of Data Array where data is to One of the Data Array names from be stored in the FieldServer Section 4 Data_Array_Offset Starting location in Data Array 0 to (Data_Array_Length-1) as specified in Section 4 Function Function of Client Map Descriptor Rdbc, Passive_Client Node_Name Name of Node to fetch data from One of the node names specified in Section 5.2. 5.3.2 Driver Specific Map Descriptor Parameters Secutron_Type Identifies the type of data the Map Descriptor points to Poller, Device, Function Secutron_Circuit Identifies the circuit or panel zone 0-99 Length The number of devices on the circuit the Map Descriptor must detect 0-999 5.3.3 Timing Parameters Scan_Interval Rate at which data is polled >= 0s Page 8 of 15
5.3.4 Map Descriptor Example. Map_Descriptor_Name, Scan_Interval, Data_Array_Name, Data_Array_Offset, Function, Node_Name, Secutron_Type, Secutron_Circuit, Length P1_POLLER, 0s, Poller, 0, Rdbc, Node_1, Poller, -, 1 P1C1_DEVICES, -, P1C1_DEVICES, 0, Passive_Client, Node_1, Device, 1, 200 P1C1_FUNCTION, -, P1C1_FUNCTION, 0, Passive_Client, Node_1, Function, 1, 200 P1C69_RESTART, -, P1C69_RESTART, 0, Passive_Client, Node_1, Device, 69, 100 P1C69_FUNCTION, -, P1C69_FUNCTION, 0, Passive_Client, Node_1, Function, 69, 100 P1C90_RESET, -, P1C90_RESET, 0, Passive_Client, Node_1, Device, 90, 100 P1C90_FUNCTION, -, P1C90_FUNCTION, 0, Passive_Client, Node_1, Function, 90, 100. Any unique name. Name will appear in Bridge Map Descriptor status information screens. The rate at which the driver polls the panel. A Data Array name must be one found under Data_Arrays. Data from a circuit event will be stored in the array at Data_Array_Offset. The Poller Data Array will contain non-zero data when communications with the panel is OK Function must be read for pollers and all others Passive_Client. A name given to the device to which the FieldServer is connected. The type of data the Map Descriptor points to. Device data contains alarm statuses. Function data contains condition codes. Refer to Appendix B.1 for more information. The circuit or zone number used to trap incoming events into the Map Descriptor. See Driver notes. The number of devices on the circuit this Map Descriptor can detect for incoming events. Page 9 of 15
6 CONFIGURING THE FIELDSERVER AS A SECUTRON MODUL-R DRIVER SERVER For a detailed discussion on FieldServer configuration, please refer to the FieldServer Configuration Manual. The information that follows describes how to expand upon the factory defaults provided in the configuration files included with the FieldServer (See.csv files provided with the FieldServer). The configuration file tells the FieldServer about its interfaces, and the routing of data required. In order to enable the FieldServer for Secutron Modul-R driver communications, the driver independent FieldServer buffers need to be declared in the Data Arrays section, the FieldServer virtual node(s) need to be declared in the Server Side Nodes section, and the data to be provided to the Client needs to be mapped in the Server Side Map Descriptors section. Details on how to do this can be found below. Note that in the tables, * indicates an optional parameter, with the bold legal value being the default. 6.1 Server Side Connection Parameters Section Title Connections Port Specify which port the device is connected to the FieldServer P1-P2 2 Baud* Specify baud rate 150, 300, 1200, 2400, 4800, 9600 (Vendor limitation) Parity* Specify parity None (Vendor limitation) Data_Bits* Specify data bits 8 (Vendor limitation) Stop_Bits* Specify stop bits 1 (Vendor limitation) Protocol Specify protocol used Secutron Example // Server Side Connections Port, Protocol, Baud, Parity P1, Secutron, 9600, None 2 Not all ports shown are necessarily supported by the hardware. Consult the appropriate Instruction manual for details of the ports available on specific hardware. Page 10 of 15
6.2 Server Side Node Parameters Section Title Nodes Node_Name Provide name for Node Up to 32 alphanumeric characters Node_ID Generic Node ID unique to port. Also used as panel number. 0-9 Protocol Specify protocol used Secutron Port Port to which node belongs P1-P2 Example // Server Side Nodes Nodes Node_Name, Node_ID, Protocol, Connection Node_1, 1, Secutron, P1 6.3 Server Side Map Descriptors 6.3.1 FieldServer Specific Map Descriptor Parameters Map_Descriptor_Name Name of this Map Descriptor Up to 32 alphanumeric characters Data_Array_Name Name of the Data Array where One of the Data Array names from Data data is to be stored in the Array section above FieldServer Data_Array_Offset Starting location in Data Array 0 to (Data_Array_Length-1) as specified in Data_Array section Function Function of Client Map Descriptor Server Node_Name The name of the Node the Map Descriptor is attached to One of the Node Names specified in Server Node Descriptor above 6.3.2 Driver Specific Map Descriptor Parameters Secutron_Type Identifies the type of data the Map Descriptor points to Device, Function Secutron_Circuit Identifies the circuit or panel zone 0-99 Length The number of devices on the circuit the Map Descriptor must represent 0-999 Page 11 of 15
6.3.3 Map Descriptor Example. Map_Descriptor_Name, Scan_Interval, Data_Array_Name, Data_Array_Offset, Function, Node_Name, Secutron_Type, Secutron_Circuit, Length P1C1_DEVICES, -, P1C1_DEVICES, 0, Passive, Node_1, Device, 1, 200 P1C1_FUNCTION, -, P1C1_FUNCTION, 0, Passive, Node_1, Function, 1, 200 P1C69_RESTART, -, P1C69_RESTART, 0, Passive, Node_1, Device, 69, 100 P1C69_FUNCTION, -, P1C69_FUNCTION, 0, Passive, Node_1, Function, 69, 100 P1C90_RESET, -, P1C90_RESET, 0, Passive, Node_1, Device, 90, 100 P1C90_FUNCTION, -, P1C90_FUNCTION, 0, Passive, Node_1, Function, 90, 100 Any unique name. Name will appear in Bridge Map Descriptor status information screens. The rate at which the driver polls the panel. A Data Array name must be one found under Data_Arrays. Data from a circuit event will be stored in the array at Data_Array_Offset. Function may not be read or write since it implements a Server. Function may only be Passive. A name given to the device to which the FieldServer is connected. The type of data the Map Descriptor points to. Device data contains alarm statuses. Function data contains condition codes. Refer to Appendix B.1 for more information. The circuit or zone number used to trap incoming events into the Map Descriptor. See Driver notes. The number of devices on the circuit this Map Descriptor can detect for incoming events. Page 12 of 15
Appendix A. TROUBLESHOOTING Appendix A.1. Driver Messages, Error Messages and Optional Map Descriptors The Client driver will report all events it receives from the panel on the RuiNet F screen. If an event is received that has no corresponding Map Descriptor defined, this will be reported on the RuiNet E screen. This is a useful configuration tool to ensure that all required data is stored. Appendix B. REFERENCE Appendix B.1. Event Function or Condition Codes When the Client driver receives an event from the panel, it stores the event s function or condition code in the Secutron_Type=function Map Descriptor s Data Array at the device number s offset, Example: Device=3 on Circuit=1 goes into alarm the Panel reports an event with function code A (Decimal 65) The Map Descriptor Secutron_Type=device, Secutron_Circuit=1 will set a bit and store the event function code A (Decimal 65) at offset 3 in the Map Descriptors Data Array. The Secutron_Type=device Map Descriptors will set a bit if any of the events listed below occur on that circuit or zone. The bit will be cleared if the panel reports the event as cleared. The following table lists the full list of event function codes ASCII value Decimal Meaning A 65 Alarm B 66 Bypass C 67 Comlink D 68 Duplicate Addressable Device E 69 Maintenance Alert G 71 Ground Fault H 72 Hot Key Pressed I 73 Illegal Addressable Device J 74 Switch M 77 Missing Addressable Device N 78 Non-Fire/Non-Reporting P 80 Pull Station Alarm Q 81 Releaser Abort R 82 Releaser Halt S 83 Supervisory T 84 Trouble or Parameter Change U 85 Wrong Device Type W 87 Waterflow Alarm Page 13 of 15
Appendix B.2. Panel Circuit or Zone numbers The panel groups events under circuit or zone numbers. When setting up a Client configuration it is necessary to create Map Descriptors to trap the events from the zones or circuits you want to see data from. If an event is received that has no corresponding Map Descriptor defined, this will be reported on the RuiNet E screen. This is a useful configuration tool to ensure that all required data is stored. Page 14 of 15
Appendix B.3. Panel Power-up, Restarts and Resets When the panel powers up or is restarted it will send an event on zone/circuit 69 device 0. When the panel is reset from the Hot Keys on the front panel, it will send an event on zone/circuit 90, device 9. The Client driver will clear all the Secutron_Type=device and Secutron_Type=function Data Arrays when it traps any of these 2 events, provided the circuit 69 and 90 Map Descriptors have been set up as per the example Map Descriptors under the Client Side configuration instructions. Other events for Circuits 69 and 90 are shown below for which a bit will be set in the Secutron_Type=device Map Descriptor s Data Array at the device offset values shown below: Circuit Program Restart (Circuit 69) Hot Key Activation (Circuit 90) Function number of the Hot Key pressed. Events 000 Power On/Hard reboot 003 Illegal Instruction 001 - Watchdog 004 Unused Interrupt 002 Clock Monitor 005 Orphan Interrupt 001 Fire Drill 026 Switch 11 On 002 - Lamp Test 027 Switch 12 On 003 Releaser Disconnect 028 Switch 13 On 004 Relay disconnect 029 Switch 14 On 005 Test mode 030 Switch 15 On 006 Signal Disconnect 031 Switch16 On 007 - Acknowledge 032 Switch 1 Off 008 Signal Silence 033 Switch 2 Off 009 - Reset 034 Switch 3 Off 010 Common Disconnect 035 Switch 4 Off 011 General Alarm 036 Switch 5 Off 012 - Halt 037 Switch 6 Off 013 - Abort 038 Switch 7 Off 013 2 nd Stage Inhibit 039 Switch 8 Off 016 Switch 1 On 040 Switch 9 Off 017 Switch 2 On 041 Switch 10 Off 018 Switch 3 On 042 Switch 11 Off 019 Switch 4 On 043 Switch 12 Off 020 Switch 5 On 044 Switch 13 Off 021 Switch 6 On 045 Switch 14 Off 022 Switch 7 On 046 Switch 15 Off 023 Switch 8 On 047 Switch16 Off 024 Switch 9 On 051 Manual Restart 025 Switch 10 On Page 15 of 15