Siemens Energy & Automation, Inc. Configuration Guide CG39-24 Rev: 4 August 2002 APACS+™ I/O Module Configuration for Version 4.40 or Higher !Notes CG39-24 Contents Table of Contents Section Title 1.0 1.1 1.2 1.3 Introduction....................................................................................................................1-1 Product Description ......................................................................................................1-1 Product Support ............................................................................................................1-2 Related Literature .........................................................................................................1-4 2.0 2.1 2.2 2.2.1 2.2.2 2.2.3 2.2.4 2.2.5 2.2.6 2.2.7 2.2.8 2.2.9 2.2.10 Enhanced Analog Module (EAM) ................................................................................2-1 EAM Module Scope Parameter ....................................................................................2-1 EAM Channel Types ....................................................................................................2-1 EAM Analog In Current ........................................................................................2-2 EAM Analog Out Current......................................................................................2-3 EAM Analog In Voltage ........................................................................................2-4 EAM Voltage Pulse In-Freq...................................................................................2-5 EAM Current Pulse In-Freq ...................................................................................2-6 EAM Voltage Pulse In-Total .................................................................................2-7 EAM Current Pulse In-Total..................................................................................2-7 EAM Disc In Voltage ............................................................................................2-8 EAM Disc In Current.............................................................................................2-8 EAM Disc Out .......................................................................................................2-9 3.0 3.1 3.2 3.3 3.4 3.5 HART® Fieldbus Module (HFM) .................................................................................3-1 HFM Transmitter Connections .....................................................................................3-1 HFM I/O Configuration................................................................................................3-1 HFM Module Scope Parameters...................................................................................3-3 HFM Channel Types ....................................................................................................3-4 Parameter Details........................................................................................................3-10 4.0 4.1 4.2 4.2.1 Input Discrete Module (IDM) .......................................................................................4-1 IDM Module Scope Parameter .....................................................................................4-1 IDM Channel Types .....................................................................................................4-1 IDM Disc In ...........................................................................................................4-1 5.0 5.1 5.1.1 5.1.2 5.2 5.2.1 5.2.2 Isolated Discrete Input Modules (IDI) .........................................................................5-1 IDI_AC Description .....................................................................................................5-1 IDI_AC Module Scope Parameter .........................................................................5-1 IDI Discrete AC Input Channel Type ....................................................................5-2 IDI_DC Description .....................................................................................................5-2 IDI_DC Module Scope Parameter .........................................................................5-3 IDI Discrete DC Input Channel Type ....................................................................5-3 6.0 6.1 6.1.1 6.1.2 6.2 Isolated Discrete Output Modules (IDO).....................................................................6-1 IDO_AC Description....................................................................................................6-1 IDO_AC Module Scope Parameter........................................................................6-1 IDO Discrete AC Output Channel Type ................................................................6-1 IDO_DC Description....................................................................................................6-2 August 2002 Page i Contents CG39-24 6.2.1 6.2.2 IDO_DC Module Scope Parameter........................................................................6-2 IDO Discrete DC Output Channel Type ................................................................6-3 7.0 7.1 7.2 7.2.1 Output Discrete Module (ODM)...................................................................................7-1 ODM Module Scope Parameter ...................................................................................7-1 ODM Channel Type .....................................................................................................7-1 ODM Disc Out .......................................................................................................7-1 8.0 8.1 8.2 8.2.1 Resistance Temperature Module (RTM).....................................................................8-1 RTM Module Scope Parameter ....................................................................................8-1 RTM Channel Types ....................................................................................................8-1 RTM RTD Input.....................................................................................................8-1 9.0 9.1 9.2 Standard Analog Input (SAI) Module .........................................................................9-1 SAI Module Scope Parameter ......................................................................................9-1 SAI Channel Type ........................................................................................................9-1 10.0 10.1 10.2 10.2.1 10.2.2 10.2.3 10.2.4 Standard Analog Module (SAM)................................................................................10-1 SAM Module Scope Parameter ..................................................................................10-1 SAM Channel Types ..................................................................................................10-1 SAM Analog In....................................................................................................10-1 SAM Analog Out .................................................................................................10-3 SAM Disc In ........................................................................................................10-5 SAM Disc Out......................................................................................................10-6 11.0 11.1 11.2 11.2.1 11.2.2 11.2.3 Standard Discrete Module (SDM)..............................................................................11-1 SDM Module Scope Parameter ..................................................................................11-1 SDM Channel Types ..................................................................................................11-1 SDM Disc In ........................................................................................................11-1 SDM Disc Out......................................................................................................11-2 SDM Disc Pulse Out ............................................................................................11-2 12.0 12.1 12.2 12.2.1 12.2.2 12.2.3 12.2.4 12.2.5 Standard Discrete Module Plus (SDM+) ...................................................................12-1 SDM+ Module Scope Parameter ................................................................................12-1 SDM+ Channel Types ................................................................................................12-1 SDM+ Disc In ......................................................................................................12-2 SDM+ Disc Out ...................................................................................................12-2 SDM+ Disc Pulse Out..........................................................................................12-3 SDM+ SOE Disc In..............................................................................................12-4 SDM+ SOE Disc Out...........................................................................................12-4 13.0 13.1 13.2 13.2.1 Voltage Input Module (VIM)......................................................................................13-1 VIM Module Scope Parameters..................................................................................13-1 VIM Channel Types ...................................................................................................13-1 VIM TIC - Thermocouple Input Channel ............................................................13-2 ii August 2002 CG39-24 14.0 14.1 14.2 14.3 14.3.1 14.3.2 14.3.3 14.4 14.5 Contents PROFIBUS Fieldbus Module (PFM) .........................................................................14-1 PFM Channel Types ...................................................................................................14-1 PFM Module Scope ....................................................................................................14-1 PFM I/O Channel Softlist Parameters ........................................................................14-2 BOOLEAN Input and Output Channels ..............................................................14-6 Packed Discrete Input and Output Channels........................................................14-6 Analog Input and Output......................................................................................14-7 Mapping Analog Channels to PROFIBUS Integer Data Types .................................14-8 Out of Range Errors....................................................................................................14-9 List of Tables Table Title Page Table 1–1 TIC Contact Information..........................................................................................................1-3 Table 2–1 EAM Module Scope Parameter ...............................................................................................2-1 Table 2–2 EAM Analog In Current Softlist Parameters ...........................................................................2-2 Table 2–3 EAM Analog Out Current Softlist Parameters ........................................................................2-3 Table 2–4 EAM Analog In Voltage Softlist Parameters...........................................................................2-4 Table 2–5 EAM Voltage Pulse In-Freq Softlist Parameters .....................................................................2-5 Table 2–6 EAM Current Pulse In-Freq Softlist Parameters......................................................................2-6 Table 2–7 EAM Voltage Pulse In-Total Softlist Parameter......................................................................2-7 Table 2–8 EAM Current Pulse In-Total Softlist Parameter ......................................................................2-8 Table 2–9 EAM Disc In Voltage Softlist Parameters ...............................................................................2-8 Table 2–10 EAM Disc Input Current Softlist Parameters ........................................................................2-8 Table 2–11 EAM Disc Output Softlist Parameters ...................................................................................2-9 Table 3–1 Table 3–2 Table 3–3 Table 3–4 Table 3–5 Table 3–6 Channel Default Fieldbus Number ..........................................................................................3-2 HFM Module Scope Softlist Parameters .................................................................................3-3 HFM Channel Types and Related Softlist Parameters.............................................................3-4 Standard Softlist Parameters ....................................................................................................3-6 Transmitter with Controller Softlist Parameters ......................................................................3-8 Model 348 FIELDPAC Softlist Parameters.............................................................................3-9 Table 4–1 IDM Module Scope Parameter ................................................................................................4-1 Table 4–2 IDM Disc In Softlist Parameter ...............................................................................................4-1 Table 5–1 IDI_AC Module Scope Parameter ...........................................................................................5-1 Table 5–2 Softlist Parameters for the IDI Discrete AC Input Channel Type ...........................................5-2 Table 5–3 IDI_DC Module Scope Parameter ...........................................................................................5-3 Table 6–1 Table 6–2 Table 6–3 Table 6–4 IDO_AC Module Scope Parameter..........................................................................................6-1 Softlist Parameters for the IDO Discrete AC Output Channel Type .......................................6-1 IDO_DC Module Scope Parameter..........................................................................................6-3 IDO Discrete DC Output Softlist Parameters ..........................................................................6-3 August 2002 iii Contents Table 7–1 Table 7–2 Table 8–1 Table 8–2 Table 8–3 CG39-24 ODM Module Scope Parameter 7-1 ODM Discrete Output Softlist Parameters...............................................................................7-1 RTM Module Scope Parameter ...............................................................................................8-1 RTM RTD Input Softlist Parameters .......................................................................................8-2 RTM Resistance Input Softlist Parameters ..............................................................................8-4 Table 9–1 XTC_CriticalXMTR Analog Input Current Range Definitions...............................................9-2 Table 10–1 Table 10–2 Table 10–3 Table 10–4 Table 10–5 SAM Module Scope Parameter ...........................................................................................10-1 SAM Analog In Softlist Parameters.....................................................................................10-2 SAM Analog Out Softlist Parameters..................................................................................10-4 SAM Discrete Input Softlist Parameters..............................................................................10-5 SAM Discrete Output Softlist Parameters ...........................................................................10-6 Table 11–1 SDM Module Scope Parameter ...........................................................................................11-1 Table 11–2 SDM Discrete Output Softlist Parameters ...........................................................................11-2 Table 11–3 SDM Discrete Output Softlist Parameters ...........................................................................11-3 Table 12–1 Table 12–2 Table 12–3 Table 12–4 Table 12–5 Table 12–6 SDM+ Module Scope Parameter .........................................................................................12-1 SDM+ Disc In Softlist Parameter ........................................................................................12-2 SDM+ Disc Out Softlist Parameters ....................................................................................12-2 SDM+ Disc Pulse Out Softlist Parameters ..........................................................................12-3 SDM+ SOE Disc In Softlist Parameters ..............................................................................12-4 SDM+ SOE Disc Out Softlist Parameters............................................................................12-5 Table 13–1 VIM Module Scope Parameters...........................................................................................13-1 Table 13–2 VIM Thermocouple Input Channel Softlist Parameters.......................................................13-2 Table 13–3 VIM Voltage Input Softlist Parameters ...............................................................................13-3 Table 14–1 Table 14–2 Table 14–3 Table 14–4 Table 14–5 Data to Channel Type Mapping ...........................................................................................14-1 ProfiDataType SoftList Parameters .....................................................................................14-5 BOOLEAN Input and Output Channels SoftList Parameters..............................................14-6 Packed Discrete Input and Output SoftList Parameters.......................................................14-6 Analog Input and Output SoftList Parameters .....................................................................14-8 List of Illustrations Figure Title Page Figure 10–1 Step Time Response of Digital Filter .................................................................................10-3 Figure 11–1 SDM Discrete Pulse Output Timing Diagram....................................................................11-3 Figure 12–1 SDM+ Discrete Pulse Output Timing Diagram..................................................................12-3 iv August 2002 CG39-24 Figure 14–1 Figure 14–2 Figure 14–3 Figure 14–4 Figure 14–5 Figure 14–6 Contents Byte_Offset for Typical Input and Output Block ...............................................................14-3 Byte_Offset for Typical Input String..................................................................................14-4 Using COM PROFIBUS to Determine Byte_Offset ..........................................................14-4 BitNumber in a Packet Discrete Data Type........................................................................14-5 Step Time Response of Digital Filter .................................................................................14-7 Out of Range Error and Hysteresis...................................................................................14-10 Significant Changes for Revision 4 Entire document updated for consistency with current Help Files. Siemens Energy & Automation, Inc., assumes no liability for errors or omissions in this document or for the application and use of information included in this document. The information herein is subject to change without notice. Procedures included in this document have been reviewed for compliance with applicable approval agency requirements and are considered sound practice. Neither Siemens Energy & Automation, Inc., nor these agencies are responsible for repairs made by the user. ProcessSuite, QUADLOG, 4-mation, and APACS+ are trademarks of Siemens Energy & Automation, Inc. All other trademarks are the property of their respective owners. © 2002 Siemens Energy & Automation, Inc. All rights reserved. August 2002 v CG39-24 1.0 Introduction Introduction This Configuration Guide provides information on the configurable elements of the APACS+™ I/O modules. This guide is intended to be used in conjunction with the configuration procedures located in Using the ProcessSuite 4-mation Configuration Software (document number CG39-20). Starting with section 2, each section in this guide presents the parameters and channel types of an individual APACS+ I/O module, as follows: • • • • • • • • • • • • • • 1.1 Section 1, Introduction Section 2, Enhanced Analog Module (EAM) Section 3, Hart Fieldbus Module (HFM) Section 4, Input Discrete Module (IDM) Section 5, Isolated Discrete Input Module (IDI) Section 6, Isolated Discrete Output Module (IDO) Section 7, Output Discrete Module (ODM) Section 8, Resistance Temperature Module (RTM) Section 9, Standard Analog Input (SAI) Module Section 10, Standard Analog Module (SAM) Section 11, Standard Discrete Module (SDM) Section 12, Standard Discrete Module (SDM+) Section 13, Voltage Input Module (VIM) Section 14, PROFIBUS Fieldbus Module Product Description APACS+ incorporates a modular design for flexible control of plant operations. The APACS+ modules are rack-mounted, DIN-sized intelligent (microprocessor-based) modules designed to perform a specific application function, such as control, communications, or I/O. They are selected individually and combined to accommodate a process application. Each APACS+ system typically consists of a power supply module, a computer module, a control module, and a complement of I/O modules. Connection between the individual APACS+ modules is provided by three busses: • MODULBUS Used by control, communications, and computer modules to share process and system information. • IOBUS Provides a control module with dedicated, secure access to field I/O points which terminate at I/O modules. • POWER BUS A triple-redundant bus providing power to APACS+ modules. The APACS+ I/O modules are a series of configurable modules acting as interfaces between control modules and field termination signals, offering a broad range of analog, discrete, and special condition I/O points. August 2002 1-1 Introduction CG39-24 All APACS+ I/O modules are configured using 4-mation™ software. During configuration, 4-mation is used to define the channel type and several parameters which vary according to channel type. After a configuration is created, it is loaded into the I/O module’s memory, and a copy of the configuration is stored in the control module’s non-volatile memory. This allows on-line removal and replacement of the module without the need for reconfiguration. 1.2 Product Support Product support can be obtained from a Technical Information Center (TIC). Each regional TIC is a customer service center that provides direct telephone support on technical issues related to the functionality, application, and integration of all products supplied by Siemens regional TIC contact information is provided in Table 1–1. Your regional TIC is the first place you should call when seeking product support information. When calling, it is helpful to have the following information ready: • Caller name and company name • Product part number or model number and version • If there is a problem with product operation: - Whether the problem is intermittent - The steps performed before the problem occurred - Any error messages or LED indications displayed - Installation environment Customers that have a service agreement (ServiceSuite or Field Service Agreement) are granted access to the secure area of our Web site (http://www.smpa.siemens.com/TechServices/TechLibrary.asp). This area contains a variety of product support information. To log on, you will be prompted to enter your username and password. 1-2 August 2002 CG39-24 Introduction Table 1–1 TIC Contact Information TIC NORTH AMERICA Tel: +1 215 646 7400, extension 4842 Fax: +1 215 283 6343 E-mail: Hours of Operation: Secure Web Site: TIC ASIA 8 a.m. to 5 p.m. eastern time Monday – Friday (except holidays) www.smpa.siemens.com/techservices Tel: +65 299 6051 Fax: +65 299 6053 E-mail: Hours of Operation: Secure Web Site: TIC EUROPE [email protected] [email protected] 9 a.m. to 6 p.m. Singapore time Monday – Friday (except holidays) www.smpa.siemens.com/techservices Tel: +44 1935 470172 Fax: +44 1935 706969 E-mail: [email protected] Hours of Operation: 8:30 a.m. to 5:15 p.m. GMT/BST Monday – Thursday (except holidays) 8:30 a.m. to 4:00 p.m. GMT/BST Friday (except holidays) Secure Web Site: August 2002 www.smpa.siemens.com/techservices 1-3 Introduction 1.3 CG39-24 Related Literature The following literature is available from Siemens. Generally, all needed documentation is supplied on a CD-ROM supplied with your system. Refer to it as needed or as directed in text. • Getting Started with APACS+ 4-mation Configuration Software (document number SG39-12) • Using the APACS+ 4-mation Configuration Software (document number CG39-20) • APACS+ Control Simulator (document number CG39CTRLSIM-1) • APACS+ 4-mation Configuration Software Messages and Diagnostic Codes (document number CG39-21) • APACS+ Module Diagnostic Error Codes (document number CG39-19) " 1-4 August 2002 CG39-24 2.0 Enhanced Analog Module (EAM) Enhanced Analog Module (EAM) The Enhanced Analog Module (EAM) can interface both analog and discrete I/O signals to the control module’s IOBUS. Each of its 16 configurable channels can be configured as an analog input, analog output, frequency input, totalizer input, discrete input, or discrete output. Related signals, such as the I/O for a particular loop, can be grouped together to permit isolation and ease in responding to faults. Each channel is electrically isolated from the module’s CPU, IOBUS, and ground, as well as from every other channel. 2.1 EAM Module Scope Parameter Table 2-1 shows the Module Scope softlist parameter for the EAM. Table 2–1 EAM Module Scope Parameter PARAMETER ScanRate SELECTION N/A DEFAULT N/A To view/edit the module scope parameters, place the cursor on the desired module in the module tree and select the Edit, Object/Item menu item. The Hardware Modules dialog box opens. Choose the “Softlist” command button. The Module Scope Softlist dialog box opens. ScanRate: This is a read-only parameter that displays the current scan period of the module. In general, the scan rate is the same as the scan period of the ACM, but may be an integer multiple of the ACM’s scan period. 2.2 EAM Channel Types The following channel types are supported for the EAM module: • • • • • • • • • • EAM Analog In Current EAM Analog Out Current EAM Analog In Voltage EAM Voltage Pulse In-Freq EAM Current Pulse In-Freq EAM Voltage Pulse In-Total EAM Current Pulse In-Total EAM Disc In Voltage EAM Disc In Current EAM Disc Out Channel August 2002 2-1 Enhanced Analog Module (EAM) 2.2.1 CG39-24 EAM Analog In Current The EAM Analog In Current channel type returns a REAL variable. Table 2-2 shows the softlist parameters for the EAM Analog Input Current channel type. Table 2–2 EAM Analog In Current Softlist Parameters PARAMETER InputRange Resolution MinScale MaxScale EngUnits SELECTION 4-20 mA, 0-20 mA 13, 14, 15, and 16 bits Any Real Number Any Real Number in, ft, mm, cm, m, in3, ft3, bbl, ml, liter, m3, lb, ton, mol, g, kg, ft/sec, m/sec,ft/sec2, msec2, DegF, DegR, DegC, DegK, psi, psia, psig, InH2O, InHg, ATM, kPa, kPaa, kPag, mmHg, kg/cm2, mbar, bar, lb/ft3, g/cm3, kg/m3, mol/m3, ft3/lb, m3/kg, ppm, pH, PPH, KPPH, t/day, kg/hr, kg/day, gal/min, GPM, GPH, GPD, ACFM, ACFH, SCCM, SCFH, SCFM, MCFH, yd3/hr, yd3/day, BPD, gal/hr, gal/day, m3/hr, m3/day, l/min, l/hr, l/day, mV, Volts, mA, AMPS, Ohms, mhos, W, kW, MW, Btu, Btu/SCF, Btu/lbm, Btu/hr, hp, bhp, vars, VA, kVA, joules, Percent, pulses, Hz, rpm, deg, rad, cal/SCF, cal/hr, cal/lbm, kcal, kcal/SCF, kcal/hr, kcal/lbm DEFAULT 4-20 mA 13 bits 0.0 100.0 Percent InputRange: EAM Analog Input channels are configurable to operate with two current ranges: 4-20 mA or 0-20 mA. Resolution: The EAM employs sigma-delta method of analog-to-digital conversion. Both the resolution of a sigma-delta converter and normal mode rejection are improved by increasing the filtering amount. The degree of filtering appropriate for the selected resolution is applied to the signal within the EAM, before the signal is scanned by the ACM. MinScale: The module linearly scales raw data (mA) to engineering units for each channel. The scaling algorithm uses the MinScale/MaxScale and InputRange parameters set by the user. For example, given a MinScale of 0.0, a MaxScale of 100.0, and an InputRange of 4-20 mA, if the input to the channel is 12 mA, the scaled value is 50.0 mA. MinScale can be any real (REAL) number (Real numbers are valid between -3.4028E38 and +3.4028E38.). MaxScale: MaxScale can be any real (REAL) number. EngUnits: Engineering units for the scaled value can be selected from a list of common engineering units. 2-2 August 2002 CG39-24 2.2.2 Enhanced Analog Module (EAM) EAM Analog Out Current The EAM Analog Out Current channel type accepts a REAL variable. Table 2-3 lists the softlist parameters for the EAM Analog Output Current channel type. Table 2–3 EAM Analog Out Current Softlist Parameters PARAMETER OutputRange MinScale MaxScale EngUnits IOBUSFault PresetValue FailSafe SELECTION 4-20 mA, 0-20 mA Any Real Number Any Real Number in, ft, mm, cm, m, in3, ft3, bbl, ml, liter, m3, lb, ton, mol, g, kg, ft/sec, m/sec,ft/sec2, msec2, DegF, DegR, DegC, DegK, psi, psia, psig, InH2O, InHg, ATM, kPa, kPaa, kPag, mmHg, kg/cm2, mbar, bar, lb/ft3, g/cm3, kg/m3, mol/m3, ft3/lb, m3/kg, ppm, pH, PPH, KPPH, t/day, kg/hr, kg/day, gal/min, GPM, GPH, GPD, ACFM, ACFH, SCCM, SCFH, SCFM, MCFH, yd3/hr, yd3/day, BPD, gal/hr, gal/day, m3/hr, m3/day, l/min, l/hr, l/day, mV, Volts, mA, AMPS, Ohms, mhos, W, kW, MW, Btu, Btu/SCF, Btu/lbm, Btu/hr, hp, bhp, vars, VA, kVA, joules, Percent, pulses, Hz, rpm, deg, rad, cal, cal/SCF, cal/hr, cal/lbm, kcal, kcal/SCF, kcal/hr, kcal/lbm OFF, HOLD LAST STATE, PRESET VALUE 0.0 to 100.0 % ENABLED, DISABLED DEFAULT 4-20 mA 0.0 100.0 Percent OFF 0.0 DISABLED OutputRange: EAM Analog Output Current channels are configurable to operate with two current ranges: 4-20 mA or 0-20 mA. MinScale: The module performs a linear conversion from engineering units to the selected OuputRange for each channel. The scaling algorithm uses the MinScale/MaxScale and OutputRange parameters set by the user. For example, given a MinScale of 0.0, a MaxScale of 100.0, and an OutputRange of 4-20 mA, if the value written to the EAM Analog Output Channel is 50, the module will output 12 mA. MinScale can be any real (REAL) number (Real numbers are valid between -3.4028E38 and +3.4028E38.). MaxScale: MaxScale can be any real number. EngUnits: Engineering units for the scaled value can be selected from a list of common engineering units. IOBUSFault: Each analog output can be configured to respond to an IOBUS fault (loss of communications with the controller) in a particular manner. The available fault states are: OFF HOLD_LAST_STATE PRESET_VALUE August 2002 Output is turned off (0 mA). Output holds its last value. Output goes to the value specified by the PresetValue parameter. 2-3 Enhanced Analog Module (EAM) CG39-24 NOTE All channels power up in the OFFstate. PresetValue: Any real (REAL) number between 0.0 and 100.0. This parameter need only be specified when IOBUSFault is specified as “Preset_Value.” FailSafe: If FailSafe is enabled and an error condition exists for which the channel cannot be turned off individually, then all channels of the module are powered down. The user may wish to configure an output as Failsafe that is critical to the process or that may present a hazard to personnel or equipment. 2.2.3 EAM Analog In Voltage The EAM Analog In Voltage channel type returns a REAL variable. Table 2-4 lists the softlist parameters for the EAM Analog Input Voltage channel type. Table 2–4 EAM Analog In Voltage Softlist Parameters PARAMETER InputRange Resolution MinScale MaxScale EngUnits SELECTION 1-5 V, 0-5 V 13, 14, 15, and 16 bits Any Real Number Any Real Number In, ft, mm, cm, m, in3, ft3, bbl, ml, liter, m3, lb, ton, mol, g, kg, ft/sec, m/sec,ft/sec2, msec2, DegF, DegR, DegC, DegK, psi, psia, psig, InH2O, InHg, ATM, kPa, kPaa, kPag, mmHg, kg/cm2, mbar, bar, lb/ft3, g/cm3, kg/m3, mol/m3, ft3/lb, m3/kg, ppm, pH, PPH, KPPH, t/day, kg/hr, kg/day, gal/min, GPM, GPH, GPD, ACFM, ACFH, SCCM, SCFH, SCFM, MCFH, yd3/hr, yd3/day, BPD, gal/hr, gal/day, m3/hr, m3/day, l/min, l/hr, l/day, mV, Volts, mA, AMPS, Ohms, mhos, W, kW, MW, Btu, Btu/SCF, Btu/lbm, Btu/hr, hp, bhp, vars, VA, kVA, joules, Percent, pulses, Hz, rpm, deg, rad, cal, cal/SCF, cal/hr, cal/lbm, kcal, kcal/SCF, kcal/hr, kcal/lbm DEFAULT 1-5 V 13 bits 0.0 100.0 Percent InputRange: EAM Analog In Voltage channels are configurable to operate with two voltage ranges, 1-5 V or 0-5 V. Resolution: The EAM employs sigma-delta method of analog-to-digital conversion. The resolution of a sigma-delta converter and normal mode rejection are improved by increasing the amount of filtering. The degree of filtering, appropriate for the selected resolution, is applied to the signal within the EAM, before the signal is scanned by the ACM. MinScale: The module will linearly scale raw data (volts) to engineering units for each channel. The scaling algorithm uses the MinScale/MaxScale and InputRange parameters set by the user. For example, given a MinScale of 0.0, a MaxScale of 100.0, and an InputRange of 1-5 Volts, if the input to the channel is 3 Volts, the scaled value will be 50.0. 2-4 August 2002 CG39-24 Enhanced Analog Module (EAM) MinScale can be any real (REAL) number. (Real numbers are valid between -3.4028E38 and +3.4028E38). MaxScale: MaxScale can be any real number. EngUnits: Engineering units for the scaled value can be selected from a list of common engineering units. 2.2.4 EAM Voltage Pulse In-Freq The Voltage Pulse In-Freq channel type returns a REAL variable. Table 2-5 shows the softlist parameters for the Voltage Pulse Input-Frequency channel type. Table 2–5 EAM Voltage Pulse In-Freq Softlist Parameters PARAMETER Threshold MinRange MaxRange MinScale MaxScale EngUnits Resolution SELECTION Regular, TTL 0.0 to 45,000 Hz 0.0 to 45,000 Hz Any Real Number Any Real Number In, ft, mm, cm, m, in3, ft3, bbl, ml, liter, m3, lb, ton, mol, g, kg, ft/sec, m/sec,ft/sec2, msec2, DegF, DegR, DegC, DegK, psi, psia, psig, InH2O, InHg, ATM, kPa, kPaa, kPag, mmHg, kg/cm2, mbar, bar, lb/ft3, g/cm3, kg/m3, mol/m3, ft3/lb, m3/kg, ppm, pH, PPH, KPPH, t/day, kg/hr, kg/day, gal/min, GPM, GPH, GPD, ACFM, ACFH, SCCM, SCFH, SCFM, MCFH, yd3/hr, yd3/day, BPD, gal/hr, gal/day, m3/hr, m3/day, l/min, l/hr, l/day, mV, Volts, mA, AMPS, Ohms, mhos, W, kW, MW, Btu, Btu/SCF, Btu/lbm, Btu/hr, hp, bhp, vars, VA, kVA, joules, Percent, pulses, Hz, rpm, deg, rad, cal, cal/SCF, cal/hr, cal/lbm, kcal, kcal/SCF, kcal/hr, kcal/lbm 10, 12, 14, 16 bit DEFAULT Regular 0.0 45,000.0 0.0 45,000.0 Hz 12 bit Threshold: The user can select the threshold for voltage input pulses. The regular threshold is 2.5 V with 130 mV of hysteresis. The TTL threshold is 1.4 V with 130 mV of hysteresis. MinRange: The MinRange parameter allows the user to specify a minimum operating value in Hz. If the reading drops below this value, an underrange error is reported. MaxRange: The MaxRange parameter allows the user to specify a maximum operating value in Hz. If the reading goes above this value, an overrange error is reported. MinScale: The module linearly scales raw data (Hz) to engineering units for each channel. The scaling algorithm uses the MinScale/MaxScale and MinRange/MaxRange parameters set by the user. For example, given a MinScale of 0.0, a MaxScale of 100.0, a MinRange of 0 and a MaxRange of 10,000, if the input to the channel is 5,000 Hz, the scaled value is 50.0 Hz. August 2002 2-5 Enhanced Analog Module (EAM) CG39-24 MinScale can be any real number (Real numbers are valid between -3.4028E38 and +3.4028E38.). MaxScale: MaxScale can be any real number. EngUnits: Engineering units for the scaled value can be selected from a list of common engineering units. Resolution: The EAM counts the number of pulses occurring in a measured length of time. The frequency of the waveform is calculated by dividing the number of pulses by the corresponding length of time. Increasing the resolution increases the length of time in which pulses are accumulated. To meet certain application requirements, the selection of 10-bit resolution actually yields 11-bit resolution. This provides better than 0.06% accuracy, with a minimal delay. 2.2.5 EAM Current Pulse In-Freq The Current Pulse In-Freq channel type returns a REAL variable. Table 2-6 lists the softlist parameters for the Current Pulse Input-Frequency channel type. Table 2–6 EAM Current Pulse In-Freq Softlist Parameters PARAMETER InputRange MinRange MaxRange MinScale MaxScale EngUnits Resolution SELECTION 4-20 mA, 0-20 mA 0.0 to 45,000 Hz 0.0 to 45,000 Hz Any Real Number Any Real Number in, ft, mm, cm, m, in3, ft3, bbl, ml, liter, m3, lb, ton, mol, g, kg, ft/sec, m/sec,ft/sec2, msec2, DegF, DegR, DegC, DegK, psi, psia, psig, InH2O, InHg, ATM, kPa, kPaa, kPag, mmHg, kg/cm2, mbar, bar, lb/ft3, g/cm3, kg/m3, mol/m3, ft3/lb, m3/kg, ppm, pH, PPH, KPPH, t/day, kg/hr, kg/day, gal/min, GPM, GPH, GPD, ACFM, ACFH, SCCM, SCFH, SCFM, MCFH, yd3/hr, yd3/day, BPD, gal/hr, gal/day, m3/hr, m3/day, l/min, l/hr, l/day, mV, Volts, mA, AMPS, Ohms, mhos, W, kW, MW, Btu, Btu/SCF, Btu/lbm, Btu/hr, hp, bhp, vars, VA, kVA, joules, Percent, pulses, Hz, rpm, deg, rad, cal, cal/SCF, cal/hr, cal/lbm, kcal, kcal/SCF, kcal/hr, kcal/lbm 10, 12, 14, 16 bit DEFAULT 0-20 mA 0.0 45,000.0 0.0 45,000.0 Hz 12 bit InputRange: Current Pulse In-Freq channels are configurable to operate with two current ranges, 4-20 mA or 0-20 mA. The threshold for both ranges is fixed at 10 mA, with a hysteresis of 0.5 mA. MinRange: The MinRange parameter allows the user to specify a minimum operating value in Hz. If the reading drops below this value, an underrange error is reported. MaxRange: The MaxRange parameter allows the user to specify a maximum operating value in Hz. If the reading goes above this value, an overrange error is reported. 2-6 August 2002 CG39-24 Enhanced Analog Module (EAM) MinScale: The module linearly scales raw data (Hz) to engineering units for each channel. The scaling algorithm uses the MinScale/MaxScale and MinRange/MaxRange parameters set by the user. For example, given a MinScale of 0.0, a MaxScale of 100.0, a MinRange of 0, a MaxRange of 10,000, and if the input to the channel is 5,000 Hz, the scaled value is 50.0 Hz. MinScale can be any real number (Real numbers are valid between -3.4028E38 and +3.4028E38.). MaxScale: MaxScale can be any real number. Units: Engineering units for the scaled value can be selected from a list of common engineering units. Resolution: The EAM counts the number of pulses occurring in a measured length of time. The frequency of the waveform is calculated by dividing the number of pulses by the corresponding time. Increasing the resolution increases the length of time in which pulses are accumulated. To meet certain application requirements, the selection of 10-bit resolution actually yields 11-bit resolution. This provides better than 0.06% accuracy with a minimal delay. 2.2.6 EAM Voltage Pulse In-Total The EAM Voltage Pulse In-Total channel type returns a UDINT variable. The EAM Voltage Pulse In-Total channel type must be used with the EAM_TOT function block. For more information on this function block, refer to APACS+ ACM Standard Function Blocks Version 4.40 or Higher Configuration Guide (document number CG39-22). Table 2-7 shows the softlist parameter for the EAM Voltage Pulse Input-Total channel type. Table 2–7 EAM Voltage Pulse In-Total Softlist Parameter PARAMETER Threshold SELECTION Regular, TTL DEFAULT Regular Threshold: The user can select the threshold for voltage input pulses. The Regular threshold is 2.5 V, with 130 mV of hysteresis. The TTL threshold is 1.4 V, with 130 mV of hystersis. 2.2.7 EAM Current Pulse In-Total The Current Pulse In-Total channel type returns a UDINT variable. The Current Pulse In-Total channel type must be used with the EAM_TOT function block. August 2002 2-7 Enhanced Analog Module (EAM) CG39-24 Table 2-8 shows the softlist parameter for the EAM Current Pulse In-Total: Table 2–8 EAM Current Pulse In-Total Softlist Parameter PARAMETER InputRange SELECTION DEFAULT 4-20 mA, 0-20 mA 0-20 mA InputRange: Current Pulse In-Total channels are configurable to operate with two current ranges, 4-20 mA or 0-20 mA. The threshold for both ranges is fixed at 10 mA, with a hysteresis of 0.5 mA. NOTE Selecting 0-20 mA disables “open-input” diagnostic errors. 2.2.8 EAM Disc In Voltage The EAM Disc In Voltage channel type returns a BOOL variable. Table 2-9 shows the softlist parameters for the EAM Discrete Input Voltage channel type. Table 2–9 EAM Disc In Voltage Softlist Parameters PARAMETER MinOnStatePct MaxOffStatePct SELECTION 0.0 to 100 0.0 to 100 DEFAULT 80.0 20.0 MinOnStatePct: The reading is automatically scaled from 0-5 V to 0-100%. A scaled reading greater than or equal to MinOnStatePct will report a boolean TRUE to the controller. MaxOffStatePct: The reading is automatically scaled from 0-5 V to 0-100%. A reading less than or equal to MaxOffStatePct will report a boolean FALSE to the controller. 2.2.9 EAM Disc In Current The EAM Disc In Current channel type returns a BOOL variable. Table 2-10 shows the softlist parameters for the EAM Discrete Input Current channel type. Table 2–10 EAM Disc Input Current Softlist Parameters PARAMETER MinOnStatePct MaxOffStatePct 2-8 SELECTION 0.0 to 100 0.0 to 100 DEFAULT 80.0 20.0 August 2002 CG39-24 Enhanced Analog Module (EAM) MinOnStatePct: The reading is automatically scaled from 0-20 mA to 0-100%. A scaled reading greater than or equal to MinOnStatePct reports a boolean TRUE to the control module. MaxOffStatePct: The reading is automatically scaled from 0-20 mA to 0-100%. A reading less than or equal to MaxOffStatePct reports a boolean FALSE to the control module. 2.2.10 EAM Disc Out The EAM Disc Out Channel type accepts a BOOL variable. Table 2-11 shows the softlist parameters for the EAM Disc Output channel type. Table 2–11 EAM Disc Output Softlist Parameters PARAMETER IOBUSFault FailSafe SELECTION OFF, ON, HOLD_LAST_STATE ENABLED, DISABLED DEFAULT OFF DISABLED IOBUSFault: Each EAM Disc Output channel can be configured to respond to an IOBUS fault (loss of communications with the controller) in a particular manner. The available fault states are: OFF ON HOLD_LAST_STATE Output is turned off. Output is turned on. Output holds its last value. NOTE All channels power up in the OFF state. FailSafe: If FailSafe is enabled and an error condition exists for which the channel cannot be turned off individually, then all channels of the module are powered down. The user may wish to configure an output as FailSafe that is critical to the process or that may present a hazard to personnel or equipment. " August 2002 2-9 CG39-24 3.0 HART® Fieldbus Module (HFM) HART® Fieldbus Module (HFM) The HART® Fieldbus Module (HFM) is an I/O module that integrates smart transmitters with the APACS+ system. Smart transmitters that incorporate the HART protocol, such as the Siemens XTC and Rosemount products, are supported. The HFM provides analog input and digital (HART) communication with the transmitter. For most transmitters, the HFM can completely configure the parameters in the transmitter. Configuration is performed by editing the softlist for each channel. The HFM can also connect to a non-smart transmitter that simply uses a 4 to 20 mA signal. 3.1 HFM Transmitter Connections The HFM has 16 "fieldbuses" to which transmitters are wired. A fieldbus consists of a set of four screw terminals, PWR, VIN, COM and SHLD. The fieldbus number is silkscreened on the HFM termination strip (16112-21) or marshalled termination assembly (16191-1). Refer to the service instructions (document number SD39HFM) on the HFM for wiring and power supply information. Note that the HFM has an on-board power supply that can output up to 360 mA to power transmitters (a total of 90 transmitters can be powered with 360 mA). An external power supply (28VDC) can be connected to the termination strip for backup or additional power. Transmitters can be connected to an HFM in single-drop or multi-drop mode. Note that any mix of singledrop and multi-drop fieldbuses is permitted on a single HFM. In single-drop mode, one transmitter is wired to a fieldbus, and the HFM provides a fast update of the analog value from the transmitter. Transmitters that are providing a process variable for use in control algorithms in an ACM are typically connected in single-drop mode. The poll address of the transmitter should be set to 0 during single-drop mode. For a normal transmitter, a poll address of 0 causes the analog current to respond proportionally to the primary variable. However, for an XTC with controller enabled, the analog current corresponds to the valve signal, which typically drives an I/P transducer or valve positioner. In multi-drop mode, up to eight transmitters can be wired to a single fieldbus. Each transmitter must be assigned a unique poll address from 1 to 15, which will park each transmitter's current to 4 mA. XTC transmitters with the controller enabled should not be connected in multi-drop mode. Note that although the HART specification indicates that 15 transmitters can be wired on a single fieldbus, we have chosen the limit to be eight in order to provide reasonable HART communication updates. To summarize the capacities, 16 HART transmitters (one per fieldbus) can be connected to a HFM in single-drop mode. XTC transmitters with controller enabled must be connected in single-drop mode, and therefore up to 16 can be connected to one HFM. A maximum of 90 HART transmitters with up to eight per fieldbus can be connected to a HFM in multi-drop mode without an external supply or up to 128 HART transmitters with an external supply. 3.2 HFM I/O Configuration Similar to other APACS+ I/O modules, each field device (transmitter) is assigned a channel number in the I/O channel table. Along with the channel number, the user identifies the channel type, which in this case selects what type of transmitter will be connected. The channel types are listed in section 3.4. The user can also enter a TagName that will become the global variable name for that I/O channel in the APACS+ August 2002 3-1 HART® Fieldbus Module (HFM) CG39-24 system. (The default tagname is the physical address, RxxSxxCxxx). This value is updated every scan of the IOBUS. An I/O global TagName is delimited by the preceding percent symbol (%). Note that the specific transmitter value that corresponds to the global TagName depends on the chosen channel type. For example, if the channel type is Siemens XTC w/Controller, then the global TagName corresponds to the digitally-read ProcessVariable. If the channel type is Generic XMTR SingleDrop, then the global TagName is the analog current signal that corresponds to the primary variable. Each transmitter or channel number has a softlist with additional parameters to configure and view. It is important to configure the Fieldbus_Number parameter properly because this identifies the physical set of screws to which a transmitter is wired. Since it is possible to have multiple transmitters wired on a Fieldbus, several channel numbers may have the same Fieldbus_Number. However, the channel number, from 1 to 128, is always unique for each device. Each channel has a default Fieldbus. Table 3-1 shows the default Fieldbus_Number for each channel. Table 3–1 Channel Default Fieldbus Number FIELDBUS NUMBER 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 3-2 CHANNELS 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 August 2002 CG39-24 3.3 HART® Fieldbus Module (HFM) HFM Module Scope Parameters Table 3-2 lists the Module Scope softlist parameters for the HFM. Table 3–2 HFM Module Scope Softlist Parameters PARAMETER ScanRate FB_01_Timeout FB_01_Preambles FB_02_Timeout FB_02_Preambles FB_03_Timeout FB_03_Preambles FB_04_Timeout FB_04_Preambles FB_05_Timeout FB_05_Preambles FB_06_Timeout FB_06_Preambles FB_07_Timeout FB_07_Preambles FB_08_Timeout FB_08_Preambles FB_09_Timeout FB_09_Preambles FB_10_Timeout FB_10_Preambles FB_11_Timeout FB_11 Preambles FB_12_Timeout FB_12_Preambles FB_13_Timeout FB_13_Preambles FB_14_Timeout FB_14_Preambles FB_15_Timeout FB_15_Preambles FB_16_Timeout FB_16_Preambles SELECTION T#100ms 256-10,000 5-40 256-10,000 5-40 256-10,000 5-40 256-10,000 5-40 256-10,000 5-40 256-10,000 5-40 256-10,000 5-40 256-10,000 5-40 256-10,000 5-40 256-10,000 5-40 256-10,000 5-40 256-10,000 5-40 256-10,000 5-40 256-10,000 5-40 256-10,000 5-40 256-10,000 5-40 DEFAULT T#100ms 256 5 256 5 256 5 256 5 256 5 256 5 256 5 256 5 256 5 256 5 256 5 256 5 256 5 256 5 256 5 256 5 To view/edit the Module Scope parameters, place the cursor on the desired Module in the module tree and select the Edit, Object/Item menu item. The Hardware Modules dialog box opens. Choose the Softlist command button. The Module Scope Softlist dialog box opens. ScanRate: The effective scan rate of the HFM analog Inputs and collection of scan data can be changed. If the HFM cannot scan at the ACM rate, the HFM will bump up its scan rate by the ACM rate until the scan rate is managed by the HFM. August 2002 3-3 HART® Fieldbus Module (HFM) FB_01_Timeout thru FB_16_Timeout CG39-24 Each Fieldbus Timeout parameter determines the amount of time a Fieldbus will wait before reporting that the command sent did not receive a response. The time unit is milliseconds and the allowable range of values is 256 to 10,000. FB_01_Preambles Each Fieldbus Preamble parameter determines the number of hexadecimal "F" characters prefixed to the HART command. These characters give HART devices a Thru FB_16_Preambles warning that a command is coming. The allowable range of values is 5 to 40. 3.4 HFM Channel Types This section describes the channel types and softlist parameters for the HFM and includes Table 3-3, HFM Channel Types and Related Softlist Parameters. Each channel type in the HFM has many of the same parameters. Because of the large number of HFM parameters, a “shorthand” list of the parameters, with those that apply to each channel type indicated, is provided in Table 3-3. This section also provides other tables listing all of the HFM softlist parameters for transmitters and those for the Model 348 FieldPac. Table 3–3 HFM Channel Types and Related Softlist Parameters CHANNEL TYPE Siemens XTC SingleDrop Siemens XTC w/Controller Siemens XTC MultiDrop Generic XMTR SingleDrop Generic XMTR MultiDrop Analog Only Siemens 348 FieldPac 3-4 SOFTLIST PARAMETER All but parameters 60-88 All but parameters 51,52,54,55 All but parameters 51,52,54,55 from standard list. All but parameters 18,19,24-26,38,4446 from standard list. All but parameters 18,19,24-26,38,4446,51, 52,54,55 from standard list. Only parameters 51-55 from standard list. All but parameters 18,19,24-26,38,4446,51, 58 from standard list, plus those in FIELDPAC specific list. GLOBAL VALUE Analog-read process variable HART-read process variable HART-read process variable Analog-read primary variable HART-read primary variable Analog-read current input HART-Read Process Variable August 2002 CG39-24 HART® Fieldbus Module (HFM) The complete list of softlist parameters is shown in the following tables. The transmitter softlist parameters (parameter numbers 1 through 59), shown in the standard table, are standard for each channel type. Softlist parameters 56-58 were intentionally omitted. Each channel type that requires parameters beyond the standard list will begin these parameters at parameter number 60. These additional parameters are shown in additional lists. The parameter numbers shown here will not appear in the 4-mation softlist, however, they are significant. These parameter numbers appear in Siemens internal diagnostic software that can be used during staging to help find configuration problems. Depending on the channel type, the HFM will provide the indicated global value as part of the IOBUS scan update. Scaling of the global value is accomplished by the softlist parameters, as noted below, depending on the channel type. Siemens XTC SingleDrop PV_Range_Lo and _Hi scale the process variable. MinScale and MaxScale parameters are automatically set equal to PV_Range _Lo and PV_Range_Hi respectively. Siemens XTC w/Controller PV_Range_Lo and _Hi scale the process variable. MinScale and MaxScale parameters are not provided. Siemens XTC MultiDrop PV_Range_Lo and _Hi scale the process variable. MinScale and MaxScale parameters are not provided. Generic XMTR SingleDrop PV_Range_Lo and _Hi scale the process variable. MinScale and MaxScale parameters are automatically set equal to PV_Range _Lo and PV_Range_Hi respectively. Generic XMTR MultiDrop PV_Range_Lo and _Hi scale the percent-of-range value read from the transmitter to calculate the process variable. Analog Only MinScale and MaxScale parameters scale the analog current input. Siemens 348 FIELDPAC PV_Range_Lo and _Hi scale the process variable. The channel type assigned must be the correct type for the device. If the assigned channel type does not match the actual device connected, the Generic HART device type will be used. August 2002 3-5 HART® Fieldbus Module (HFM) CG39-24 Table 3-4 lists the standard softlist parameters for all channel types. Table 3–4 Standard Softlist Parameters TRANSMITTER NUMBER PARAMETER 1 Fieldbus_Number 2 Poll_Address 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 Transmitter_Tag OverwriteXmtrCfg Descriptor Message_Part_A Message_Part_B Date_Month Date_Day Date_Year DeviceSerialNum MeasuredVariable MV_Units MV_Range_Lo MV_Range_Hi Damping TransferFunction InputType 19 20 21 22 23 24 25 BurnoutDirection ProcessVariable PV_Units PV_Range_Lo PV_Range_Hi AutoRerange LocalDisplayCode 26 27 28 29 30 31 32 33 34 35 36 FailsafeLevel Current PercentOfRange Manuf_ID_Code DeviceTypeCode DeviceID_Number SensorSerialNum SensorLimitUnits LowerSensorLimit UpperSensorLimit Minimum_Span 3-6 SELECTION 1-16 0-15 *** (8 char) TRUE, FALSE *** (16 char) *** (16 char) *** (16 char) 1-12 1-31 00 - 99 0 - 16,777,214 N/A *** *** *** *** 0=Linear, 1=SQ Root 0=Narrow mV, 1=R thermocouple (tc), 2=S tc, 3=T tc, 4=B tc 0=Upscale, 1=Downscale N/A (4 char) *** *** TRUE, FALSE 0=Percent, 1=Measured, Variable, 2=Process Variable 0=Lo, 1=Hi, 2=LPBFS 4 to 20 mA fixed current N/A N/A N/A N/A N/A *** *** *** *** DEFAULT See Table 3-1 Defaults to 0 for single- drop channel '' FALSE '' '' '' 12 1 93 0d N/A - Read Only 0 0.0 0.0 0.0 0 0 0 N/A - Read Only ENGU 0.0000 100.00 FALSE 0 0 0 N/A - Read Only N/A - Read Only N/A - Read Only N/A - Read Only N/A - Read Only N/A - Read Only N/A - Read Only N/A - Read Only N/A - Read Only August 2002 CG39-24 NUMBER 37 38 39 40 41 42 43 44 45 HART® Fieldbus Module (HFM) TRANSMITTER PARAMETER AlarmSelectCode MooreModelNum SupplierCode DataBaseRevNum S_H_RevLevels Misc_Status DeviceStatus MooreStatus MooreTransState MooreDeviceError 46 47 48 49 50 51 52 53 DeviceErrStat_1 DeviceErrStat_2 DeviceErrorMsg WriteRspMessage MinScale MaxScale EngUnits 54 55 59 DigFiltTimeCnst StepResponseTime CommErrorRate SELECTION 0=High, 1=Low *** N/A N/A N/A See description below See description below See description below 3=Off-line, 5=On-line, 7=Configuration Hold 0=no error, 1=Communication Error, 2=ROM Error, 3=RAM Error, 4=EEPROM Error, 5=Watchdog Error, 6=Sensor Error *** *** N/A N/A Any Real Number Any Real Number DEFAULT N/A - Read Only N/A - Read Only N/A - Read Only 0 N/A - Read Only 0 0 0 N/A - Read Only N/A - Read Only N/A - Read Only N/A - Read Only N/A - Read Only N/A - Read Only 0.0 100.0 in, ft, mm, cm, m, in3, ft3, bbl, ml, liter, m3, lb, ton, mol, g, Percent kg, ft/sec, m/sec,ft/sec2, msec2, DegF, DegR, DegC, DegK, psi, psia, psig, InH2O, InHg, ATM, kPa, kPaa, kPag, mmHg, kg/cm2, mbar, bar, lb/ft3, g/cm3, kg/m3, mol/m3, ft3/lb, m3/kg, ppm, pH, PPH, KPPH, t/day, kg/hr, kg/day, gal/min, GPM, GPH, GPD, ACFM, ACFH, SCCM, SCFH, SCFM, MCFH, yd3/hr, yd3/day, BPD, gal/hr, gal/day, m3/hr, m3/day, l/min, l/hr, l/day, mV, Volts, mA, AMPS, Ohms, mhos, W, kW, MW, Btu, Btu/SCF, Btu/lbm, Btu/hr, hp, bhp, vars, VA, kVA, joules, Percent, pulses, Hz, rpm, deg, rad, cal cal/SCF, cal/hr, cal/lbm, kcal, kcal/SCF, kcal/hr, kcal/lbm 0.0 to 159.0 sec 0.050 to 2.000 sec 0 0.0 1.0 0 N/A indicates not applicable. *** indicates “refer to the appropriate transmitter documentation.” NOTE Because all Siemens devices use packed ASCII for the parameters of string data type, any changes to these parameters must be entered in uppercase letters. August 2002 3-7 HART® Fieldbus Module (HFM) CG39-24 Table 3-5 is a list of the transmitter with controller specific softlist parameters. Table 3–5 Transmitter with Controller Softlist Parameters NUMBER 60 61 62 63 64 XTC w/CONTROLLER PARAMETER LoopProcess LoopSetpoint LoopValve LoopStatus AutomaticMode 65 66 67 68 69 70 71 72 73 74 75 76 ControllerOn ControllerType DirectAction LoopPG LoopTI LoopTD LoopDG LoopMR ManualResetTrack TrackingSetpoint PowerUpSetpoint PowerUpManual 77 78 79 80 81 82 83 84 85 86 87 88 AutoModeOnly PowerUpValve AlarmStatus AlarmCommand ALARM1_Enable ALARM1_Limit ALARM1_Type ALARM2_Enable ALARM2_Limit ALARM2_Type SelfClearingNaks AlarmsOutOfServ SELECTION N/A *** *** See description below TRUE =Automatic FALSE=Manual TRUE, FALSE 1=PID,2=PD,3=ID TRUE=Direct, FALSE=Reverse *** *** *** *** *** TRUE, FALSE TRUE, FALSE *** TRUE=Manual, FALSE=Automatic TRUE, FALSE -1.0 to 110.0 See description below *** TRUE=Enabled , FALSE=disabled *** 0=LOW, 1=HIGH TRUE=Enabled , FALSE=disabled *** 0=LOW, 1=HIGH TRUE, FALSE TRUE, FALSE DEFAULT N/A - Read Only 0.0 0.0 0 FALSE TRUE 1 TRUE 1.0000 100.00 0.0000 10.000 0.0000 FALSE FALSE 50.0 FALSE FALSE 0.0 N/A 0 FALSE 0.0 0 FALSE 0.0 0 FALSE FALSE N/A indicates not applicable. *** indicates "refer to the appropriate transmitter documentation." 3-8 August 2002 CG39-24 HART® Fieldbus Module (HFM) Table 3-6 lists the 348 FIELDPAC specific softlist parameters. Table 3–6 Model 348 FIELDPAC Softlist Parameters NUMBER 60 61 62 63 64 65 66 67 68 69 348 FIELDPAC PARAMETER LoopNumber LoopTagName (LD) ProcessVariable (LD) PV_Units (LD) PV_Range_Hi (LD) PV_Range_Lo (LD) Setpoint (LD) Valve (LD) LoopStatus (LD) AutomaticMode (LD) 70 ConsoleMode (LD) 71 72 73 74 75 76 77 78 79 80 81 82 83 84 ControllerOn DirectAction AlarmStatus AlarmCommand StationStatus LoopPG LoopTI LoopTD LoopDG LoopMR TargetSetpoint RampTime RampRate Ramp (LD) (LD) (LD) (LD) 85 86 87 88 89 90 91 92 HiLimit LoLimit VariableX X_Units X_Range_HI X_Range_Lo VariableY Y_Units (LD) (LD) 93 94 95 Y_Range_HI Y_Range_Lo FB98_IND August 2002 (LD) (LD) (LD) (LD) (LD) (LD) (LD) (LD) (LD) SELECTION 1=Loop1, 2=Loop2 (12 char) N/A (4 char) *** *** *** *** See description below TRUE=Automatic FALSE=Manual TRUE=Console FALSE=Local TRUE=On, FALSE=Off TRUE=Direct, FALSE=Reverse See description below See description below See description below *** *** *** *** *** *** *** *** TRUE=Ramp, FALSE=DoNotRamp *** *** N/A (4 char) *** *** N/A (4 char) DEFAULT 1 " 0.0 " 100.0 0.0 0.0 0.0 0u TRUE *** *** N/A 0.0 0.0 0.0 FALSE TRUE TRUE 0u 0u 0u 1.0 100.0 0.0 10.0 0.0 1.0 0.0 0.0 FALSE 100.0 0.0 0.0 " 0.0 0.0 0.0 0.0 3-9 HART® Fieldbus Module (HFM) NUMBER 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 348 FIELDPAC PARAMETER FB98_INE FB98_INF FB98_ING FB98_70 FB98_71 FB98_72 FB98_73 FB98_74 Ratio Bias Preset1 Preset2 TotalizerCounts TotalizeMult TotalizerUnits HoldOutput ALARM1_Enable (LD) ALARM2_Enable (LD) ALARM3_Enable (LD) ALARM4_Enable (LD) ALARM1_Limit (LD) ALARM2_Limit (LD) ALARM3_Limit (LD) ALARM4_Limit (LD) ALARM1_Type (LD) ALARM2_Type (LD) ALARM3_Type (LD) ALARM4_Type (LD) CG39-24 SELECTION N/A N/A N/A *** *** *** *** *** *** *** *** *** N/A *** (4 char) N/A TRUE=Enabled , FALSE=disabled TRUE=Enabled , FALSE=disabled TRUE=Enabled , FALSE=disabled TRUE=Enabled , FALSE=disabled *** *** *** *** See following description See following description See following description See following description DEFAULT 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 " 0.0 FALSE FALSE FALSE FALSE 0.0 0.0 0.0 0.0 0u 0u 0u 0u N/A indicates not applicable. LD indicates loop dependent. *** indicates "refer to the appropriate transmitter documentation." 3.5 Parameter Details Some of the softlist parameters are explained in more detail below. For further explanation or a description of parameters not shown, refer to the appropriate manual(s) provided by the transmitter’s manufacturer. For example, such reference documents from Siemens include AD340-10, AD340-80, AD340-510, AD344-10 and AD344-70. The Rosemount HART - Smart Communications Protocol manual should also be referenced as needed. Fieldbus_Number (1 in Standard List): This parameter specifies the physical set of screws to which a transmitter or FIELDPAC is wired. Note that the same Fieldbus_Number can be used for more than one device, such as in multi-drop mode. 3-10 August 2002 CG39-24 HART® Fieldbus Module (HFM) Poll_Address (2 in Standard List): The poll address must be set to 0 if the analog current is to be active. An address other than 0, will park the current at 4mA. For multi-drop operation, the poll address should be set 1 to 15 and should be unique for each device on that Fieldbus. NOTE If the poll address of a channel is written while the device is communicating, the poll address of the communicating device is changed; the HFM does NOT search for a new device with that poll address. The HFM does search for a device with the new poll address if the channel has never communicated with an actual device. Transmitter_Tag (3 in Standard List): This is the eight character string stored in the transmitter. OverWriteXmtrCfg (4 in Standard List): With the HFM’s softlist, it is possible to configure a transmitter’s database by entering the desired data in each softlist parameter. This configuration can be done without the presence of the HFM or the transmitter, such as in the off-line mode of 4-mation. However, the transmitter will have its own database which may be different from that entered in the softlist. By setting this parameter to TRUE, the HFM will overwrite the configuration of the attached transmitter upon HFM power-up (writeable parameters only). If this parameter is FALSE, the transmitter’s database will be uploaded during HFM power-up and overwrite the softlist. Note that this parameter is only executed during HFM power-up; during normal operation, changes made to the softlist or the transmitter will be processed in both databases as appropriate. MV_Units (13 in Standard List): The measured variable unit descriptor is read and written as an integer number. Refer to the appropriate transmitter’s HART communication manual for a look-up table. SensorLimitUnits (33 in Standard List): The sensor limit unit descriptor is read and written as an integer number. Refer to the appropriate transmitter’s HART communication manual for a look-up table. Misc_Status (42 in Standard List): Each bit in this 16-bit word represents a status condition although the word is read as an integer. The bits that are editable are marked with an appended asterisk below. See the end of this section for information on how to change these bits. Bit 01: Bit 02: Bit 03: Bit 04 Bit 05 Bit 06: Bits 09-16 August 2002 1=Issue HART Cmd #37 *, magnitude of applied process becomes MV_Range_Lo. 1=Issue HART Cmd #36 *, magnitude of applied process becomes MV_Range_Hi. 1=Issue HART Cmd #43 *, zeroes the primary variable so it reads zero with the applied Unused Unused 1=Controller Enabled * (XTC with Controller only) Unused 3-11 HART® Fieldbus Module (HFM) CG39-24 DeviceStatus (43 in Standard List): Each bit in this 16-bit word represents a status condition, although the word is read as an integer. The following bits that are editable are marked with an appended asterisk. See the end of this section for information on how to change these bits. Note that bits 01 through 08 comprise the HART Field Device Status Word. Bit 01: Bit 02: Bit 03: Bit 04: Bit 05: Bit 06: Bit 07: Bit 08: Bit 09: Bit 10: Bit 11: Bit 12: Bit 13: Bit 14: Bit 15: Bit 16: Primary variable out of limits Non-Primary variable out of limits Analog output saturated Output in fixed current Mode Reserved Cold start occurred Configuration change Error 1=Transmitter not communicating Unused 1=Square root enabled * 1=Write Command failed Unused 1=Device configuration change * 1=Device error NAK * 1=Device error MooreStatus (44 in Standard List): Each bit in this 16-bit word represents a status condition although the word is read as an integer. The following bits that are editable are marked with an appended asterisk. See the end of this section for information on how to change these bits. Bit 01: 1=AutoRerange enabled * Bit 02: 1=Pushbutton enabled Bit 03: 1=Write protect mode * Bit 04-16: Unused MooreTransState (45 in Standard List): This parameter indicates the state of the HART device. The possible states are: 3=Off-line, 5=On-line, and 7=Configuration Hold. If other states are obtained, call your Siemens representative for assistance. MooreDeviceError (46 in Standard List): This parameters indicates the Moore device errors. DeviceErrStat_1 (47 in Standard List): See appropriate transmitter HART manual. DeviceErrStat_2 (48 in Standard List): See appropriate transmitter HART manual. DeviceErrorMsg (49 in Standard List): The HFM will return a message that describes selected error conditions. WriteRspMessage (50 in Standard List): The HFM will return a message in response to selected writes to the transmitter. This message automatically clears after a successful write. 3-12 August 2002 CG39-24 HART® Fieldbus Module (HFM) MinScale (51 in Standard List): The module will linearly scale raw data (4-20 mA) to engineering units for each channel. The scaling algorithm uses the MinScale/MaxScale parameters set by the user. For example, assume values of MinScale of 0.0 and a MaxScale of 100.0. If the input to the channel is 12mA, the scaled value will be 50.0. Note that for some channel types, MinScale will be automatically set equal to PV_Range_Lo. MinScale can be any REAL number (REAL numbers are valid between 3.4028E38 and +3.4028E38). MaxScale (52 in Standard List): MaxScale can be any REAL number. Note that for some channel types, MaxScale will be automatically set equal to PV_Range_Hi. EngUnits (53 in Standard List): Engineering units for the scaled value may be selected from a list of common engineering units. DigFiltTimeCnst (54 in Standard List): Digital filtering can be applied to analog input signals to reduce the effects of electrical noise. The digital filter is a first order lag, adjustable for time constants of 0.0159 to 159.0 seconds. Equivalent breakpoint frequencies are 10.0 to 0.001 Hz. The value can be increased for noisy signals. StepResponseTime (55 in Standard List): This parameter determines the time for the channel to fully respond to a step input. A longer StepResponseTime will provide more accurate readings. LoopStatus (63 in XTC w/Controller List and 68 in FIELDPAC List): Each bit in this 16-bit word represents a status condition, although the word is read as an integer. The following bits that are editable are marked with an appended asterisk. See the end of this section for information on how to change these bits. • Transmitter Loop Status: Bit 01: Auto/Manual Status1 = Auto, 0 = Manual * Bit 02-16: Unused • FIELDPAC Loop Status: Bit 01: Bit 02: Bit 03: Bit 04: Bit 05: Bit 06: Bit 07: Bit 08: Bit 09: Bit 10: Bit 11: Bit 12: Bit 13: Bit 14: Bit 15: Bit 16: August 2002 Auto/Manual Status, 1=Auto * Local status * Standby Sync External/Internal Status, 1=External * Console Status * Unused Setpoint Ramp Status * Unused Emergency Manual User 1 or 2 Status High limit Exceeded Low Limit Exceeded Unused Unused Auto/Manual Transfer Function Block Configured 1 = Direct Valve Bar Action, 0 = Reverse 3-13 HART® Fieldbus Module (HFM) CG39-24 StationStatus (75 in FIELDPAC List): Each bit in this 16-bit word represents a status condition although the word is read as an integer. The following bits that are editable are marked with an appended asterisk. See the end of this section for information on how to change these bits. Bit 01: Bit 02: Bit 03: Bit 04: Bit 05: Bit 06: Bit 07: Bit 08: Bit 09: Bit 10: Bit 11: Bit 12: Bit 13: Bit 14: Bit 15: Bit 16: Active Alarm Exists Alarm Not Acknowledged Flashing Bargraph Unused Configuration Hold * Unused Unused Console = 1, Local = 0 * Unused Override Status Output of Function Block 10 Unused Configuration Changed Unused Unused Error Unused AlarmStatus (79 in Transmitter w/Controller List and 73 in FIELDPAC List): Each bit in this 16bit word represents a status condition, although the word is read as an integer. The structure mimics that of the MYCRO Alarm Status Word. This parameter is edited using the AlarmCommand parameter (described below) so that the status word can be preserved. NOTE The transmitter-controller only has two alarms, so that bits 6-11 are unused in the Alarm Status parameter. Bit 01: Bit 02: Bit 03: Bit 04: Bit 05: Bit 06: Bit 07: Bit 08: Bit 09: Bit 10: Bit 11: Bit 12: Bit 13: 3-14 Alarm1 Exists Alarm1 Not Acknowledged * Alarm1 Enabled * Alarm2 Exists Alarm2 Not Acknowledged * Alarm2 Enabled * Alarm3 Exists Alarm3 Not Acknowledged * Alarm3 Enabled * Alarm4 Exists Alarm4 Not Acknowledged * Alarm4 Enabled * Alarms Out of Service * (XTC with Controller Only) August 2002 CG39-24 HART® Fieldbus Module (HFM) AlarmCommand (80 in Transmitter List and 74 in FIELDPAC List): Each bit in this 16-bit word represents a status condition identical to the AlarmStatus parameter described above. The 16-bit word is read and written as an integer. The bits that are editable are marked with an asterisk appended to the bit definitions shown above. See the end of this section for information on how to change these bits. AlarmN_Type (120 through 123 in FIELDPAC List): Sets of bits in this 16-bit word determine the type and settings of the alarms. All bits in this word can be edited. Note that this word is NOT a status word so does NOT require the procedure outlined at the end of this section to modify the bits. Bits 3 0 0 0 0 1 1 1 1 2 0 0 1 1 0 0 1 1 1 0 1 0 1 0 1 0 1 - No alarm action required - High alarm - Low alarm - High Deviation alarm - Low Deviation alarm - Absolute Deviation alarm - Out of Range alarm - No alarm action required NOTE XTC with Controller only has the High alarm or Low alarm options. Bits 5 0 0 1 1 4 0 1 0 1 - 0.1% alarm deadband 0.5% alarm deadband 1.0% alarm deadband 5.0% alarm deadband NOTE XTC with Controller only has 0.5% deadband option. Bits 8 7 6 0 0 0 0 1 1 1 1 0 0 1 1 0 0 1 1 0 1 0 1 0 1 0 1 August 2002 - 0.0 seconds delay time in 0.4 seconds delay time in 1.0 seconds delay time in 2.0 seconds delay time in 5.0 seconds delay time in 15.0 seconds delay time in 30.0 seconds delay time in 60.0 seconds delay time in 3-15 HART® Fieldbus Module (HFM) Bits 11 0 0 0 0 1 1 1 1 Bit 10 0 0 1 1 0 0 1 1 CG39-24 9 0 1 0 1 0 1 0 1 - 0.0 seconds delay time out 0.4 seconds delay time out 1.0 seconds delay time out 2.0 seconds delay time out 5.0 seconds delay time out 15.0 seconds delay time out 30.0 seconds delay time out 60.0 seconds delay time out 12 0 - Ring back not required 1 - RINGBACK Bits 13 through 16 - set to 0 FIELDPAC parameters 81-84 come from the setpoint block (function block 17 if Loop1 and function block 68 if Loop2) in the 348. Consult the 348 Configuration Guide (CG348-2) for details. Note the Loop Number softlist parameter determines to which 348 setpoint function block communication is made. FIELDPAC parameters 85-86 come from the limit blocks (function block 08 if Loop 1 and 51 if Loop 2) in the 348. Consult the 348 Configuration Guide (CG348-2) for details. FIELDPAC parameters 87-94 come from the Link Display block (function block 15) in the 348. Consult the 348 Configuration Guide (CG348-2) for details. FIELDPAC parameters 95-103 come from the HART Interface block (function block 98) in the 348. Consult the 348 Configuration Guide (CG348-2) for details. Ratio (parameter 104 in the FIELDPAC List) comes from the RATIO function block (function block 07) in the 348. Consult the 348 Configuration Guide (CG348-2) for details. Bias (parameter 105 in the FIELDPAC List) comes from the BIAS function block (function block 08) in the 348. Consult the 348 Configuration Guide (CG348-2) for details. Parameters 106-110 come from the TOTALIZER function block (16) in the 348. Consult the 348 Configuration Guide (CG348-2) for details. Parameter 111 comes from the HOLD function block. Consult the 348 Configuration Guide (CG348-2) for details. Parameters 112-123 are read from and written to the ALARM block (function block 12 if Loop 1 and 73 if Loop 2) of the 348. Note that the Loop Number softlist parameter determines to which 348 Alarm block the communication is made. 3-16 August 2002 CG39-24 HART® Fieldbus Module (HFM) 3.6 Changing Status Bits Various bits in the HFM status parameters (Misc_Status, DeviceStatus, MooreStatus, LoopStatus) are editable. Most of these bits also have individual boolean softlist parameters for easy access, so it is not necessary to use the status words for writing. However, if desired, the following paragraphs describe the procedure. Each bit that can be modified has an asterisk “*”appended to the bit definition. To change a specific bit to a 1, a mask on command is used. To change the bit to a 0, the mask off command is used. To create the mask on or mask off command: 1. In 16-bit binary format, put a 1 in the position of the bit to be masked-on/masked-off. 2. Bit position 16 (most significant bit position) in a 16 bit, one-based word is the mask-on bit. Place a 1 in this position for a mask-on command or a 0 for a mask-off command. 3. Determine the decimal equivalent of this binary number. 4. Select the status word in the softlist. 5. Enter the calculated decimal value in the edit box. 6. Choose the Change command button. The command is sent. For example, to enable the write protect mode, a 1 should be placed both in bit position 03 of a 16-bit one-based word (because the write protect bit is bit 03), and in bit position 16 (because this is the mask-on bit). Then, the binary word is converted to decimal (1000 0000 0000 0100 = 32772). This decimal value is used to write to the MooreStatus softlist parameter. " August 2002 3-17 CG39-24 4.0 Input Discrete Module (IDM) Input Discrete Module (IDM) The IDM interfaces discrete 115 or 230 Volt AC input devices with the controller’s IOBUS. The IDM supports 32 AC inputs in eight isolated groups of four channels each. This allows AC inputs from different power sources to be connected to the same module. To isolate field faults, each channel is electrically isolated from the module’s CPU, IOBUS, and ground. 4.1 IDM Module Scope Parameter Table 4-1 shows the module scope softlist parameter for the IDM: Table 4–1 IDM Module Scope Parameter PARAMETER ScanRate SELECTION N/A DEFAULT N/A To view/edit the Module Scope Parameters, place the cursor on the desired Module in the module tree and select the Edit, Object/Item menu item. The Hardware Modules Dialog Box opens. Choose the “Softlist” command button. The Module Scope Softlist Dialog Box opens. ScanRate: This is a read-only parameter that displays the current scan rate of the module. 4.2 IDM Channel Types The following channel type is supported for the IDM module: • IDM Disc In 4.2.1 IDM Disc In The IDM Discrete Input (Disc In) channel type returns a boolean (BOOL) variable. Table 4-2 shows the Disc In softlist parameter for the IDM: Table 4–2 IDM Disc In Softlist Parameter PARAMETER InputFaultState SELECTION TRUE FALSE DEFAULT TRUE InputFaultState: When an input channel has a hardware failure that makes the channel value impossible to discern, the channel reports the value configured in this softlist parameter. " August 2002 4-1 CG39-24 5.0 Isolated Discrete Input Modules (IDI) Isolated Discrete Input Modules (IDI) The Isolated Discrete Input (IDI) modules are available in AC (IDI_AC) and DC (IDI_DC) versions. 5.1 IDI_AC Description The IDI_AC module interfaces discrete 115 Vac input signals with a control module's IOBUS, supporting 16 isolated AC input channels. This enables AC inputs from different power sources to be connected to the same module. Each channel is electrically isolated from the module's CPU, IOBUS, and ground. Event recording inputs are high-speed channels used in conjunction with the functions blocks of the Sequence of Events Recorder Function Block Library for detecting, monitoring, controlling, and recording discrete state changes (i.e. events). This data is collected by a Sequence of Events (SOE)compatible module, such as the IDI_AC module, that is capable of high-speed event gathering. Events are stored to an array of strings. The data can then be viewed through the Sequence of Events Viewer, a utility program. Refer to the APACS+ Sequence of Events Viewer Operator's Guide (document number OG39SOE-2) for information on using this utility. 5.1.1 IDI_AC Module Scope Parameter Table 5-1 shows the Module Scope softlist parameter for the IDI_AC module. To view/edit the module scope parameter, place the cursor on the desired module in the module tree. From the Main Menu bar, select the Edit, Object/Item to open the Hardware Modules dialog box. Press the Softlist command button to open the Module Scope Softlist dialog box. Table 5–1 IDI_AC Module Scope Parameter PARAMETER ScanRate SELECTION Not applicable DEFAULT 25 ms ScanRate: This is a read-only parameter that displays the current scan rate of the module. August 2002 5-1 Isolated Discrete Input Modules (IDI) 5.1.2 CG39-24 IDI Discrete AC Input Channel Type The IDI Discrete AC Input channel type returns a boolean (BOOL) variable. Table 5-2 shows the softlist parameters for this channel type. Table 5–2 Softlist Parameters for the IDI Discrete AC Input Channel Type PARAMETER SOE_Recording Description EventPriority AlarmState SELECTION ENABLE, DISABLE Any 28 characters 1-4 TRUE, FALSE DEFAULT DISABLE ‘’ 1 FALSE SOE_Recording: This parameter enables or disables SOE recording for this channel. Description (only relevant if SOE_Recording is enabled): This is a description, up to 28 characters, of the channel that is monitored for configuration by the Sequence of Events Recorder block. The description is formatted as a STRING data type. It is inserted as a substring within the EVENTS string of the Sequence of Events Recorder block. EventPriority (only relevant if SOE_Recording is enabled): This data is used for establishing an event’s priority. You can set a channel’s priority from 1 (highest) to 4 (lowest). This priority value can then be used to sort events, such as during the time that they are being formatted for viewing. This priority value is inserted within the EVENTS string of the Sequence of Events Recorder block. AlarmState: This parameter is used to establish the alarm state of the channel. You can choose which state, TRUE or FALSE, represents an alarm condition. For example, if you set this parameter to TRUE, the channel is said to be in alarm when the channel’s value toggles from FALSE to TRUE. This also inserts an “A” character in the last character position in the EVENTS string of the Sequence Of Events block. Otherwise, it is an “N” character (no alarm). 5.2 IDI_DC Description The IDI_DC module interfaces discrete 125 Vdc input signals with a control module's IOBUS, supporting 24 isolated DC input channels. This enables DC inputs from different power sources to be connected to the same module. Each channel is electrically isolated from the module's CPU, IOBUS, and ground. Event recording inputs are high-speed channels used in conjunction with the function blocks of the Sequence of Events Recorder Function Block Library for detecting, monitoring, controlling, and recording discrete state changes (i.e. events). This data is collected by a Sequence of Events (SOE)compatible module, such as the IDI, that is capable of high-speed event gathering. Events are stored to an array of strings. The data can then be viewed through the Sequence of Events Viewer, a utility program. Refer to the APACS+ Sequence of Events Viewer Operator's Guide (document number OG39SOE-2) for information on the use of this utility. 5-2 August 2002 CG39-24 5.2.1 Isolated Discrete Input Modules (IDI) IDI_DC Module Scope Parameter Table 5-3 shows the Module Scope softlist parameter for the IDI_DC module. To view/edit the module scope parameter, place the cursor on the desired module in the module tree. From the Main Menu bar, select the Edit, Object/Item to open the Hardware Modules dialog box. Press the Softlist command button to open the Module Scope Softlist dialog box. Table 5–3 IDI_DC Module Scope Parameter PARAMETER ScanRate SELECTION Not applicable DEFAULT 25 ms ScanRate: This is a read-only parameter that displays the current scan rate of the module. 5.2.2 IDI Discrete DC Input Channel Type The IDI Discrete DC Input channel type returns a boolean (BOOL) variable. Table 5-4 shows the softlist parameters for this channel type. TABLE 5-4 IDI Discrete DC Output Softlist Parameters PARAMETER SOE_Recording Description EventPriority AlarmState SELECTION ENABLE, DISABLE Any 28 char. 1-4 TRUE, FALSE DEFAULT DISABLE ‘’ 1 FALSE SOE_Recording: This parameter enables or disables SOE recording for this channel. Description (only valid if SOE_Recording is enabled): This is a description, up to 28 characters, of the channel that is monitored for configuration by the Sequence of Events Recorder block. The description is formatted as a STRING data type. It is inserted as a substring within the EVENTS string of the Sequence of Events Recorder block. EventPriority (only valid if SOE_Recording is enabled): This data is used for establishing an event’s priority. You can set a channel’s priority from 1 (highest) to 4 (lowest). This priority value can then be used to sort events, such as during the time that they are being formatted for viewing. This priority value is inserted within the EVENTS string of the Sequence of Events Recorder block. AlarmState: This parameter is used to establish the alarm state of the channel. You can choose which state, TRUE or FALSE, represents an alarm condition. For example, if you set this parameter to TRUE, the channel is said to be in alarm when the channel’s value toggles from FALSE to TRUE. This also inserts an ‘A’ character in the last character position in the EVENTS string of the Sequence Of Events block. Otherwise, it is an ‘N’ character (no alarm). " August 2002 5-3 CG39-24 6.0 Isolated Discrete Output Modules (IDO) Isolated Discrete Output Modules (IDO) The Isolated Discrete Output (IDO) modules are available in AC (IDO_AC) and DC (IDO_DC) versions. 6.1 IDO_AC Description The IDO interfaces discrete 24 to 125 Vac output devices with a control module's IOBUS, supporting 16 isolated output channels. This enables outputs requiring different power sources to be connected to the same module. Furthermore, each channel is electrically isolated from the module's CPU, IOBUS, and ground. 6.1.1 IDO_AC Module Scope Parameter Table 6-1 shows the Module Scope softlist parameter for the IDO_AC module. To view/edit the module scope parameter, place the cursor on the desired module in the module tree. From the Main Menu bar, select the Edit, Object/Item to open the Hardware Modules dialog box. Press the Softlist command button to open the Module Scope Softlist dialog box. Table 6–1 IDO_AC Module Scope Parameter PARAMETER ScanRate SELECTION Not applicable DEFAULT 25 ms ScanRate: This is a read-only parameter that displays the current scan rate of the module. 6.1.2 IDO Discrete AC Output Channel Type The IDO Discrete AC Output channel type accepts a boolean (BOOL) variable. Table 6-2 shows the softlist parameters for this channel type. Table 6–2 Softlist Parameters for the IDO Discrete AC Output Channel Type PARAMETER IOBUSFault FailSafe FieldWiringDiag Readback SOE_Recording Description EventPriority AlarmState SELECTION OFF, ON, HOLD ENABLE, DISABLE ENABLE, DISABLE ENABLE, DISABLE ENABLE, DISABLE Any 28 characters 1-4 TRUE, FALSE DEFAULT OFF DISABLE ENABLE ENABLE DISABLE ‘’ 1 FALSE IOBUSFault: If the IDO module is unable to communicate with the control module (loss of IOBUS), the output is set to the IOBUSFault state. Once set to the IOBUSFault state, the diagnostic must be acknowledged for normal output updates to occur again. August 2002 6-1 Isolated Discrete Output Modules (IDO) CG39-24 FailSafe: When FailSafe is set to ENABLE, the module turns off the output via the diagnostic cut-off switch if diagnostics detect that the output is ON when it is supposed to be OFF. FieldWiringDiag: These diagnostics determine whether an open-circuit is present on a channel that is currently OFF. Disabling FieldWiringDiag prevents the brief pulse ON required for these diagnostics from occurring. Note that loads of less than 50 mA (100 mA Node-to-Node redundant) may not be reported correctly by these diagnostics. Readback: The IDO contains circuitry on every output to “read back” the actual output current. Readback is used to diagnose channel faults, such as an open circuit, short circuit, blown fuse on Marshalled Termination Assembly, module hardware fault field device hardware fault, or excessive current draw. Disabling Readback inhibits reporting of Readback-related diagnostics. Disabling ReadBack does not disable the controller readback diagnostic. SOE_Recording: This parameter enables or disables SOE recording for this channel. Description (only valid if SOE_Recording is enabled): This is a description, up to 28 characters, of the channel that is monitored for configuration by the Sequence of Events Recorder block. The description is formatted as a STRING data type. It is inserted as a substring within the EVENTS string of the Sequence of Events Recorder block. EventPriority (only valid if SOE_Recording is enabled): This data is used for establishing an event’s priority. You can set a channel’s priority from 1 (highest) to 4 (lowest). This priority value can then be used to sort events, such as during the time that they are being formatted for viewing. This priority value is inserted within the EVENTS string of the Sequence of Events Recorder block. AlarmState: This parameter is used to establish the alarm state of the channel. You can choose which state, TRUE or FALSE, represents an alarm condition. For example, if you set this parameter to TRUE, the channel is said to be in alarm when the channel’s value toggles from FALSE to TRUE. This also inserts an ‘A’ character in the last character position in the EVENTS string of the Sequence Of Events block. Otherwise, it is an ‘N’ character (no alarm). 6.2 IDO_DC Description The IDO_DC module interfaces discrete 24 to 125 Vdc output devices with a control module’s IOBUS, supporting 16 isolated output channels. This enables outputs requiring different power sources to be connected to the same module. Each channel is electrically isolated from the module’s CPU, IOBUS, and ground. 6.2.1 IDO_DC Module Scope Parameter Table 6-3 shows the Module Scope softlist parameter for the IDO_DC module. To view/edit the module scope parameter, place the cursor on the desired module in the module tree. From the Main Menu bar, select the Edit, Object/Item to open the Hardware Modules dialog box. Press the Softlist command button to open the Module Scope Softlist dialog box. 6-2 August 2002 CG39-24 Isolated Discrete Output Modules (IDO) Table 6–3 IDO_DC Module Scope Parameter PARAMETER ScanRate SELECTION Not applicable DEFAULT 25 ms ScanRate: This is a read-only parameter that displays the current scan rate of the module. 6.2.2 IDO Discrete DC Output Channel Type The IDO Discrete DC Output channel type accepts a boolean (BOOL) variable. Table 6-4 shows the softlist parameters for this channel type. Table 6–4 IDO Discrete DC Output Softlist Parameters PARAMETER IOBUSFault FailSafe FieldWiringDiag Readback SOE_Recording Description EventPriority AlarmState SELECTION OFF, ON, HOLD ENABLE, DISABLE ENABLE, DISABLE ENABLE, DISABLE ENABLE, DISABLE Any 28 characters 1-4 TRUE, FALSE DEFAULT OFF DISABLE ENABLE ENABLE DISABLE ‘’ 1 FALSE IOBUSFault: If the IDO module is unable to communicate with the control module (loss of IOBUS), the output is set to the IOBUSFault state. Once set to the IOBUSFault state, the diagnostic must be acknowledged for normal output updates to occur again. FailSafe: When FailSafe is set to ENABLE, the module turns off the output via the diagnostic cut-off switch if diagnostics detect that the output is ON when it is supposed to be OFF. FieldWiringDiag: These diagnostics determine whether an open-circuit, normal load, or short circuit, is present on a channel that is currently OFF. Disabling FieldWiringDiag prevents the brief pulse ON required for these diagnostics from occurring. Note that loads of less than 50 mA (100 mA Node-to-Node redundant) may not be reported correctly by these diagnostics. August 2002 6-3 Isolated Discrete Output Modules (IDO) CG39-24 Readback: The IDO contains circuitry on every output to “read back” the actual output current. Readback is used to diagnose channel faults, such as an open circuit, short circuit, blown fuse on Marshalled Termination Assembly, module hardware fault field device hardware fault, or excessive current draw. Disabling Readback inhibits reporting of Readback-related diagnostics. Disabling ReadBack does not disable the controller readback diagnostic. SOE_Recording: This parameter enables or disables SOE recording for this channel. Description (only valid if SOE_Recording is enabled): This is a description, up to 28 characters, of the channel that is monitored for configuration by the Sequence of Events Recorder block. The description is formatted as a STRING data type. It is inserted as a substring within the EVENTS string of the Sequence of Events Recorder block. EventPriority (only valid if SOE_Recording is enabled): This data is used for establishing an event’s priority. You can set a channel’s priority from 1 (highest) to 4 (lowest). This priority value can then be used to sort events, such as during the time that they are being formatted for viewing. This priority value is inserted within the EVENTS string of the Sequence of Events Recorder block. AlarmState: This parameter is used to establish the alarm state of the channel. You can choose which state, TRUE or FALSE, represents an alarm condition. For example, if you set this parameter to TRUE, the channel is said to be in alarm when the channel’s value toggles from FALSE to TRUE. This also inserts an ‘A’ character in the last character position in the EVENTS string of the Sequence Of Events block. Otherwise, it is an ‘N’ character (no alarm). " 6-4 August 2002 CG39-24 7.0 Output Discrete Module (ODM) Output Discrete Module (ODM) The ODM interfaces discrete 115 Volt AC devices with the controller’s IOBUS. The ODM supports 32 AC outputs in four isolated groups of eight channels each. This allows each group to use a separate power supply. Each group is individually fused with a 5 amp fuse to protect the group from a short circuit in the field wiring and prevents the short circuit from affecting other channel groups in the module. To isolate field faults, every output circuit is electrically isolated from the ODM’s CPU, IOBUS, and ground. 7.1 ODM Module Scope Parameter Table 7-1 shows the Module Scope softlist parameter for the ODM: Table 7–1 ODM Module Scope Parameter PARAMETER ScanRate SELECTION N/A DEFAULT N/A To view/edit the Module Scope Parameters, place the cursor on the desired Module in the module tree and select the Edit, Object/Item menu item. The Hardware Modules Dialog Box opens. Choose the “Softlist” command button. The Module Scope Softlist Dialog Box opens. ScanRate: This is a read-only parameter that displays the current scan rate of the module. 7.2 ODM Channel Type The following channel type is supported for the ODM. • ODM Disc Out 7.2.1 ODM Disc Out The Discrete Ouput (Disc Out) channel type accepts a boolean (BOOL) variable. Table 7-2 shows the softlist parameters for the Disc Out channel type. Table 7–2 ODM Discrete Output Softlist Parameters PARAMETER IOBUSFault FailSafe Readback August 2002 SELECTION OFF, ON, HOLD_LAST_STATE ENABLED, DISABLED ENABLED, DISABLED DEFAULT OFF DISABLED ENABLED 7-1 Output Discrete Module (ODM) CG39-24 IOBUSFault: Each output can be configured to respond to an IOBUS fault (loss of communications with the controller) in a particular manner. The available fault states are: OFF ON HOLD_LAST_STATE Output is turned off. Output is turned on. Output holds its last value. NOTE All channels power up in the OFF state. FailSafe: Each output can be configured to turn off all module outputs in the group in the event that a channel is intended to be off, but diagnostics have determined that it is on or opencircuited. The user may wish to configure an output as FailSafe that is critical to the process or may present a hazard to personnel or equipment. Readback: The state of an output channel is automatically “read back” by circuitry on the same channel. The Readback is used to diagnose and report faults. The user can disable Readback, which in turn disables the reporting of Readback-related faults (Output Open Circuit or Failed On, Output Failed Off, Critical Output Open Circuit or Failed On). " 7-2 August 2002 CG39-24 8.0 Resistance Temperature Module (RTM) Resistance Temperature Module (RTM) The RTM interfaces RTD and other resistance input signals to the controller’s IOBUS. The RTM provides 16 configurable channels isolated into eight groups of two channels each. Each input circuit is isolated from the Module’s CPU, IOBUS, and ground. In addition, each two-channel group is isolated from the other groups. 8.1 RTM Module Scope Parameter Table 8-1 shows the Module Scope softlist parameter for the RTM: Table 8–1 RTM Module Scope Parameter PARAMETER ScanRate SELECTION NA DEFAULT NA To view/edit the Module Scope Parameters, place the cursor on the desired module in the module tree and select the Edit, Object/Item menu item. The Hardware Modules dialog box opens. Choose the “Softlist” command button. The Module Scope Softlist dialog box opens. ScanRate: This is a read-only parameter that displays the current scan rate of the module. In general, the scan rate is the same as the scan rate of the ACM, but may be a multiple of the ACM's scan rate. Shared_RTD: This parameter is no longer used. 8.2 RTM Channel Types The following channel types are supported for the RTM module: • • RTM RTD Input RTM Resistance Input 8.2.1 RTM RTD Input The RTD Input channel type returns a REAL variable. August 2002 8-1 Resistance Temperature Module (RTM) CG39-24 Table 8-2 shows the softlist parameters for the RTD Input channel type. Table 8–2 RTM RTD Input Softlist Parameters PARAMETER RTD_Type Alpha Resistance Bias EngUnits MinRange MaxRange Scale_To_Percent Input_Fault_State DigFiltTimeCnst StepResponseTime SELECTION Pt_100_IEC/DIN Pt_100_JIC/SAMA Pt_200_IEC/DIN Pt_200_JIC/SAMA Ni_100 _DIN Linear Any Real Number 10.0 to 200.0 Ohms Any Real Number DegF, DegC, DegK, Deg R Any Real Number >= MinRange of selected RTD Any Real Number <= MaxRange of selected RTD Yes_No Enforced by RTM board No_Change, MinRange, MaxRange 0.0 to 159.0 sec. 0.100 to 40.000 sec. DEFAULT Pt_100_IEC/DIN 0.00385 100.0 0.0 Deg C Min Range of selected RTD Type Max Range of selected RTD Type No MinRange 0.016 1.0 RTD_Type: Select from the list of supported RTD types. If “Linear” is selected, the measured input, R, is linearized using a straight line approximation based on the Alpha, α, and Resistance, R0, specified. T( ° C) = R R0 α R0 Alpha: Alpha is the average percent change in resistance per degree of a pure metal resistance device between 0 and 100º C. The most commonly used element material is standard platinum with a resistance of 100 Ohms at 0º C and a temperature coefficient of resistance of 0.00385 ohms/ohm/ºC (IEC 751 and DIN 43760). This parameter need only be specified when the RTD type specified is “Linear.” Resistance: The resistance in ohms of the RTD at 0º C. This parameter need only be specified when the RTD type specified is “Linear.” Bias: The user can enter a bias (in engineering units) on a per channel basis to compensate for known offsets. The bias value is added to the linearized input. 8-2 August 2002 CG39-24 Resistance Temperature Module (RTM) EngUnits: The user can select from the following engineering units: DegF, DegC, DegK, DegR MinRange: MinRange is an optional parameter that allows the user to specify a minimum operating value in EngUnits. If the reading drops 5% below this value, an underrange error is reported. MaxRange: MaxRange is an optional parameter that allows the user to specify a maximum operating value in EngUnits. If the reading goes 5% above this value, an overrange error is reported. Scale_To_Percent: If Scale_To_Percent is TRUE, the linearized temperature reading, T, is scaled to a percent by the following formula: %= TMinRange x100 MaxRangeMinRange Input_Fault_State: If a channel is faulted (Quality is set to BAD or QUESTIONABLE), the user can select to have the module return the actual reading (No_Change), the largest value for the channel (Maxscale), or the smallest value (Minscale). The default is to return the actual reading. DigFiltTimeCnst: Digital filtering can be applied to RTD input signals to reduce the effects of electrical noise. The digital filter is a first-order lag, adjustable for time constants of 0.0159 to 159.0 seconds. Equivalent breakpoint frequencies are 10.0 to 0.001 Hz. The default value can be increased for noisy signals. StepResponseTime: This parameter determines the time for the channel to fully respond to a step input. A longer StepResponseTime provides more accurate readings. The valid range is between 0.100 and 40.00 seconds. 8.2.2 RTM Resistance Input The Resistance Input channel type returns a REAL variable. DigFiltTimeCnst: This parameter sets the time constant of a low-pass digital filter applied to the input data. This filter reduces non-repetitive noise from the input data and can be disabled by setting this parameter to 0.0. StepResponseTime: This parameter sets the length of a moving-average digital filter applied to the input data. It determines the time to fully respond to an input step. Increasing this parameter reduces periodic or repetitive input noise and improves repeatability and resolution. The recommended setting for this parameter is between 1.0 and 10.0 seconds. August 2002 8-3 Resistance Temperature Module (RTM) CG39-24 Table 8-3 shows the softlist parameters for the RTM Resistance Input channel type. Table 8–3 RTM Resistance Input Softlist Parameters PARAMETER MinRange MaxRange MinScale MaxScale EngUnits Bias Input_Fault_State DigFiltTimeCnst StepResponseTime SELECTION 15 to 1015 Ohms 15 to 1015 Ohms Any Real Number Any Real Number in, ft, mm, cm, m, in3, ft3, bbl, ml, liter, m3, lb, ton, mol, g, kg, ft/sec, m/sec,ft/sec2, msec2, DegF, DegR, DegC, DegK, psi, psia, psig, InH2O, InHg, ATM, kPa, kPaa, kPag, mmHg, kg/cm2, mbar, bar, lb/ft3, g/cm3, kg/m3, mol/m3, ft3/lb, m3/kg, ppm, pH, PPH, KPPH, t/day, kg/hr, kg/day, gal/min, GPM, GPH, GPD, ACFM, ACFH, SCCM, SCFH, SCFM, MCFH, yd3/hr, yd3/day, BPD, gal/hr, gal/day, m3/hr, m3/day, l/min, l/hr, l/day, mV, Volts, mA, AMPS, Ohms, mhos, W, kW, MW, Btu, Btu/SCF, Btu/lbm, Btu/hr, hp, bhp, vars, VA, kVA, joules, Percent, pulses, Hz, rpm, deg, rad, cal, cal/SCF, cal/hr, cal/lbm, kcal, kcal/SCF, kcal/hr, kcal/lbm Any Real Number No_Change, MinRange, MaxRange 0.0 to 159.0 sec. 0.100 to 40.000 sec. DEFAULT 15.0 1015.0 0.0 100.0 Percent 0.0 MinRange 0.016 1.0 MinRange: MinRange is an optional parameter that allows the user to specify a minimum operating value in EngUnits. If the reading drops below this value, an underrange error is reported. MaxRange: MaxRange is an optional parameter that allows the user to specify a maximum operating value in EngUnits. If the reading goes above this value, an overrange error is reported. MinScale: The module will linearly scale raw data (ohms) to engineering units for each channel. The scaling algorithm uses the MinScale/MaxScale and MinRange/MaxRange parameters set by the user. For example, given a MinScale of 0.0, a MaxScale of 100.0, a MinRange of 0, and a MaxRange of 1000, if the input to the channel is 500 Ohms, the scaled value will be 50.0. MinScale can be any REAL number (REAL numbers are valid between -3.4028E38 and +3.4028E38). MaxScale: MaxScale can be any REAL number. EngUnits: Engineering units for the scaled value can be selected from a list of common engineering units. Bias: The user can enter a bias (in engineering units) on a per channel basis to compensate for known offsets. The bias value is added to the linearized input. 8-4 August 2002 CG39-24 Resistance Temperature Module (RTM) Input_Fault_State: If a channel is faulted (Quality is set to “Bad” or “Questionable”), the user can select to have the module return the actual reading (No_Change), the largest value for the channel (Maxscale), or the smallest value (Minscale). The default is to return the actual reading. DigFiltTimeCnst: Digital filtering can be applied to RIC input signals to reduce the effects of electrical noise. The digital filter is a first-order lag, adjustable for time constants of 0.0159 to 159.0 seconds. Equivalent breakpoint frequencies are 10.0 to 0.001 Hz. The default value can be increased for noisy signals. StepResponseTime: This parameter determines the time for the channel to fully respond to a step input. A longer StepResponseTime provides more accurate readings. The valid range is between 0.100 and 40.00 seconds. " August 2002 8-5 CG39-24 9.0 Standard Analog Input (SAI) Module Standard Analog Input (SAI) Module The SAI Module interfaces up to 32 channels of analog input signals from field devices to a control module's IOBUS. 9.1 SAI Module Scope Parameter To view/edit the module scope parameter, place the cursor on the desired module in the module tree. From the Main Menu Bar, select the Edit, Object/Item to open the Hardware Modules dialog box. Press the Softlist command button to open the Module Scope Softlist dialog box. Softlist Parameter ScanRate: This is a read-only parameter that displays the current scan rate of the module. The scan rate is fixed at 25 msec. The SAI module scans asynchronous to the ACM. 9.2 SAI Channel Type The SAI Analog In channel type for the SAI Module is described here. The SAI Analog In channel type returns a REAL variable. Softlist Parameters MinScale: The module linearly scales raw data (4-20 mA) to engineering units for each channel. The scaling algorithm uses the MinScale/MaxScale parameter values that you set. For example, given a MinScale of 0.0 and a MaxScale of 100.0. If the input to the channel is 12 mA, the scaled value is 50.0. MinScale can be any REAL number (REAL numbers are valid between -3.4028E38 and +3.4028E38) MaxScale: MaxScale can be any REAL number. EngUnits: Engineering units for the scaled value can be selected from a list of common engineering units. DigFiltTimeCnst: Digital filtering can be applied to analog input signals to reduce the effects of electrical noise. The digital filter is a first order lag, adjustable for time constants of 0.0159 to 159.0 seconds (0.0 disables the filter). Equivalent breakpoint frequencies are 10.0 to 0.001 Hz. The default value can be increased for noisy signals. Bias: You can enter a bias in engineering units, on a per channel basis, to compensate for known offsets. The bias value is added to the scaled input. InputRange: SAI analog input channels are configurable to operate with one of two voltage ranges ranges: 1-5 Vdc (corresponds to current range 4 - 20 ma) (default) 0-5 Vdc (corresponds to current range 0 - 20 ma) August 2002 9-1 Standard Analog Input (SAI) Module CG39-24 OpenCircuitTest: You can enable or disable open circuit testing. An open circuit condition exists if the reading is < 0.3.6 mA. XTC_CriticalXMTR: When this parameter is TRUE, the Siemens Model 345 XTC Critical Transmitter limits are used for over/under range, open/short circuit, and transducer failure indications as defined in the following table. When this parameter is FALSE, the over/under range is extended to include the transmitter failure range, so transmitter failure is not reported. This parameter should be set to FALSE for non-critical transmitters. Table 9–1 XTC_CriticalXMTR Analog Input Current Range Definitions CURRENT RANGE (MA) >=21.0 >20.5 to <21.0 >20.0 to <20.5 20.0 4.0 >=3.8 to <4.0 >3.6 to <3.8 <=3.6 9-2 XTC_CriticalXMTR=TRUE Short circuit (or transducer failed high) Transducer failed high Over range MaxScale MinScale Under range Transducer failed (safe) low Open circuit (or transducer failed low) XTC_CriticalXMTR=FALSE Short circuit Over range Over range MaxScale MinScale Under Range Under Range Open circuit August 2002 CG39-24 Standard Analog Module (SAM) 10.0 Standard Analog Module (SAM) The Standard Analog Module (SAM) can interface both analog and discrete I/O signals to the controller’s IOBUS. The SAM provides 32 channels, each of which can be configured for standard I/O types. Related signals, such as the I/O for a particular loop, can be grouped together. To isolate field faults, each channel is electrically isolated from the Module’s CPU, IOBUS, and ground. Also, each channel uses an isolated 24 V power source, and all channels are current-limited to protect against short circuits. 10.1 SAM Module Scope Parameter Table 10-1 shows the Module Scope softlist parameter for the SAM: Table 10–1 SAM Module Scope Parameter PARAMETER ScanRate SELECTIONS N/A DEFAULT N/A To view/edit the module scope parameters, place the cursor on the desired module in the module tree and select the Edit, Object/Item menu item. The Hardware Modules dialog box opens. Choose the “Softlist” command button. The Module Scope Softlist dialog box opens. ScanRate: This is a read-only parameter that displays the current scan rate of the module. In general, the scan rate is the same as the scan rate of the ACM, but may be a multiple of the ACM's scan rate. 10.2 SAM Channel Types The following channel types are supported for the SAM module. • • • • SAM Analog In SAM Analog Out SAM Disc In SAM Disc Out 10.2.1 SAM Analog In The SAM Analog Input (Analog In) channel type returns a real (REAL) variable. August 2002 10-1 Standard Analog Module (SAM) CG39-24 Table 10-2 shows the softlist parameters for the SAM Analog In channel type. Table 10–2 SAM Analog In Softlist Parameters PARAMETER MinScale MaxScale EngUnits DigFiltTimeCnst Bias OpenCircuitTest SELECTION Any Real Number Any Real Number in, ft, mm, cm, m, in3, ft3, bbl, ml, liter, m3, lb, ton, mol, g, kg, ft/sec, m/sec,ft/sec2, msec2, DegF, DegR, DegC, DegK, psi, psia, psig, InH2O, InHg, ATM, kPa, kPaa, kPag, mmHg, kg/cm2, mbar, bar, lb/ft3, g/cm3, kg/m3, mol/m3, ft3/lb, m3/kg, ppm, pH, PPH, KPPH, t/day, kg/hr, kg/day, gal/min, GPM, GPH, GPD, ACFM, ACFH, SCCM, SCFH, SCFM, MCFH, yd3/hr, yd3/day, BPD, gal/hr, gal/day, m3/hr, m3/day, l/min, l/hr, l/day, mV, Volts, mA, AMPS, Ohms, mhos, W, kW, MW, Btu, Btu/SCF, Btu/lbm, Btu/hr, hp, bhp, vars, VA, kVA, joules, Percent, pulses, Hz, rpm, deg, rad, cal, cal/SCF, cal/hr, cal/lbm, kcal, kcal/SCF, kcal/hr, kcal/lbm 0.0 to 159.0 sec Any Real Number ENABLED, DISABLED DEFAULT 0.0 100.0 Percent 0.0 0.0 ENABLED MinScale: The module linearly scales raw data (4-20 mA) to engineering units for each channel. The scaling algorithm uses the MinScale/MaxScale parameters set by the user. For example, given a MinScale of 0.0 and a MaxScale of 100.0, if the input to the channel is 12mA, the scaled value is 50.0. MinScale can be any real (REAL) number (Real numbers are valid between -3.4028E38 and +3.4028E38.) MaxScale: MaxScale can be any real (REAL) number. EngUnits: Engineering units for the scaled value can be selected from a list of common engineering units. DigFiltTimeCnst: Digital filtering can be applied to analog input signals to reduce the effects of electrical noise. The digital filter is a first-order lag, adjustable for time constants of 0.0159 to 159.0 seconds (0.0 disables the filter). Equivalent breakpoint frequencies are 10.0 to 0.001 Hz. The default value can be increased for noisy signals. 10-2 August 2002 CG39-24 Standard Analog Module (SAM) Figure 10-1 shows the step release time of the digital filter. Step Response Time of Digital Filter Scan Rate = 100ms T (DigFiltTimeCnst) = 1.0 sec. 20 15 mA 14 (63%) Filter Input Filter Output 10 5 0 0 1 T 2 3 4 5 6 7 Time (seconds) Figure 10–1 Step Time Response of Digital Filter Bias: The user can enter a bias (in engineering units) on a per channel basis to compensate for known offsets. The bias value is added to the scaled input. OpenCircuitTest: The user can enable or disable open circuit testing. An open circuit condition exists if the reading is < 0.2mA. 10.2.2 SAM Analog Out The SAM Analog Output (Analog Out) channel type accepts a REAL variable. August 2002 10-3 Standard Analog Module (SAM) CG39-24 Table 10-3 shows the softlist parameters for the SAM Analog Out channel type. Table 10–3 SAM Analog Out Softlist Parameters PARAMETER OutputRange MinScale MaxScale EngUnits IOBUSFault PresetValue FailSafe Bias ReadBack SELECTION mA_4to20, mA_0to20 Any Real Number Any Real Number in, ft, mm, cm, m, in3, ft3, bbl, ml, liter, m3, lb, ton, mol, g, kg, ft/sec, m/sec,ft/sec2, msec2, DegF, DegR, DegC, DegK, psi, psia, psig, InH2O, InHg, ATM, kPa, kPaa, kPag, mmHg, kg/cm2, mbar, bar, lb/ft3, g/cm3, kg/m3, mol/m3, ft3/lb, m3/kg, ppm, pH, PPH, KPPH, t/day, kg/hr, kg/day, gal/min, GPM, GPH, GPD, ACFM, ACFH, SCCM, SCFH, SCFM, MCFH, yd3/hr, yd3/day, BPD, gal/hr, gal/day, m3/hr, m3/day, l/min, l/hr, l/day, mV, Volts, mA, AMPS, Ohms, mhos, W, kW, MW, Btu, Btu/SCF, Btu/lbm, Btu/hr, hp, bhp, vars, VA, kVA, joules, Percent, pulses, Hz, rpm, deg, rad, cal, cal/SCF, cal/hr, cal/lbm, kcal, kcal/SCF, kcal/hr, kcal/lbm OFF, HOLD_LAST_STATE, PRESET_VALUE % ENABLED, DISABLED Any Real Number ENABLED, DISABLED DEFAULT mA_4to20 0.0 100.0 Percent OFF 0.0 DISABLED 0.0 ENABLED OutputRange: SAM Analog Output channels are configurable to operate with two current ranges: • • 4-20mA 0-20mA MinScale: The module performs a linear conversion from engineering units to the selected OuputRange for each channel. The scaling algorithm uses the MinScale/MaxScale and OutputRange parameters set by the user. For example, given a MinScale of 0.0, a MaxScale of 100.0 and an OutputRange of 4-20mA, if the value written to the SAM Analog Output Channel is 50, the module outputs 12mA. MinScale can be any real (REAL) number (Real numbers are valid between -3.4028E38 and +3.4028E38). MaxScale: MaxScale can be any Real number. EngUnits: Engineering units for the scaled value can be selected from a list of common engineering units. 10-4 August 2002 CG39-24 Standard Analog Module (SAM) IOBUSFault: Each analog output can be configured to respond to an IOBUS fault (loss of communications with the controller) in a particular manner. The available fault states are: • • • OFF HOLD_LAST_STATE PresetValue Output is turned off (0 mA) Output holds its last value Output goes to the value specified by the PresetValue parameter. NOTE All channels power up in the OFF state. PresetValue:. Percent (0.0 to 100.0%) of Scale. This parameter need only be specified when IOBUSFault is specified as “Preset_Value.” FailSafe: Each output can be configured to turn off (0 mA = -25%) all of the SAM s outputs in the event that diagnostics determine that the output current is greater than it is intended to be by 9% or more. You may wish to configure an output as FailSafe, which is critical to the process or may present a hazard to personnel or equipment. Bias: The user can enter a bias (in engineering units) on a per channel basis to compensate for known offsets. The bias value is added to the scaled output. ReadBack: The state of an output channel is automatically “read back” by input circuitry on the same channel. The Readback is used to diagnose and report faults. The user can disable Readback, which will in turn disable reporting of Readback-related faults (Open Circuit, Readback Lower than Output, Readback > Output, Readback > Output on Critical Channel). 10.2.3 SAM Disc In The SAM Discrete Input (Disc In) channel type returns a boolean (BOOL) variable. Table 10-4 shows the softlist parameters for the SAM Disc Input channel type. Table 10–4 SAM Discrete Input Softlist Parameters PARAMETER MinOnStatePct MaxOffStatePct SELECTION 0.0 to 100.0 0.0 to 100.0 DEFAULT 80.0 20.0 MinOnStatePct: The reading is automatically scaled from 0-10 mA to 0-100%. A scaled reading greater than or equal to MinOnStatePct reports a boolean TRUE to the controller. MaxOffStatePct: The reading is automatically scaled from 0-10 mA to 0-100%. A reading less than or equal to MaxOffStatePct reports a boolean FALSE to the controller. August 2002 10-5 Standard Analog Module (SAM) CG39-24 10.2.4 SAM Disc Out The SAM Discrete Output (Disc Out) channel type accepts a boolean (BOOL) variable. Table 10-5 shows the softlist parameters for the SAM Disc Output channel type. Table 10–5 SAM Discrete Output Softlist Parameters PARAMETER IOBUSFault FailSafe ReadBack SELECTION OFF, ON, HOLD_LAST_STATE ENABLED, DISABLED ENABLED, DISABLED DEFAULT OFF DISABLED ENABLED IOBUSFault: Each SAM Disc Output channel can be configured to respond to an IOBUS fault (loss of communications with the controller) in a particular manner. The available fault states are: • • • OFF ON HOLD_LAST_STATE Output is turned off (0 mA) Output is turned on (100%) (23mA) Output holds its last value NOTE All channels power up in the OFF state. FailSafe: Each output can be configured to turn Off (0mA) all of the SAM’s outputs in the event that diagnostics determine that the output current is greater that it is intended to be by 9% or more. You may wish to configure an output as FailSafe that is critical to the process, or which may present a hazard to personnel or equipment. ReadBack: The state of an output channel is automatically “read back” by input circuitry on the same channel. The Readback is used to diagnose and report faults. The user can disable Readback, which in turn disables reporting of Readback-related faults (Readback Lower than Output, Readback > Output, Readback > Output on Critical Channel). " 10-6 August 2002 CG39-24 Standard Discrete Module (SDM) 11.0 Standard Discrete Module (SDM) The Standard Discrete Module (SDM) interfaces discrete DC sensors and actuators with the APACS+ controller’s IOBUS. The SDM provides 32 channels, each of which can be configured to be an input, output, or pulse output. The SDM’s inputs are current sinking (i.e. the input device is wired between the power supply positive (+) and the I/O terminal). Outputs are sourced (i.e. the output device is wired between the output terminal and the power supply common). A pulsed output is an output channel that is “ON” for a user-defined duration (within the range of 10 to 2000 msec). All input and output circuits are electrically isolated from the SDM’s CPU, IOBUS, and ground. In addition, each output is individually fused with a replaceable miniature fuse. This protects the output channel from a short circuit in the field wiring and prevents the short circuit from affecting other channels on the module. 11.1 SDM Module Scope Parameter Table 11-1 shows the Module Scope softlist parameter for the SDM: Table 11–1 SDM Module Scope Parameter PARAMETER ScanRate SELECTION NA DEFAULT NA To view/edit the module scope parameters, place the cursor on the desired module in the module tree and select the Edit, Object/Item menu item. The Hardware Modules dialog box opens. Choose the “Softlist” command button. The Module Scope Softlist dialog box opens. ScanRate: This is a read-only parameter that displays the current scan rate of the module. 11.2 SDM Channel Types The following channel types are supported for the SDM module: • • • SDM Disc In SDM Disc Out SDM Pulse Out 11.2.1 SDM Disc In The SDM Discrete Input (Disc In) channel returns a boolean (BOOL) variable. There are no softlist parameters for the Disc In channel. August 2002 11-1 Standard Discrete Module (SDM) CG39-24 11.2.2 SDM Disc Out The SDM Discrete Output (Disc Out) channel type accepts a boolean (BOOL) variable. Table 11-2 shows the softlist parameters for the SDM Discrete Output channel type. Table 11–2 SDM Discrete Output Softlist Parameters PARAMETER IOBUSFault FailSafe Readback SELECTION OFF, ON, HOLD_LAST_STATE ENABLED, DISABLED ENABLED, DISABLED DEFAULT OFF DISABLED ENABLED IOBUSFault: Each output can be configured to respond to an IOBUS fault (loss of communications with the controller) in a particular manner. The available fault states are: OFF ON HOLD_LAST_STATE Output is turned off. Output is turned on. Output holds its last value. NOTE All channels power up in the OFF state. FailSafe: Each output can be configured to turn off all module outputs in the event that a channel is intended to be off, but diagnostics have determined that it is on. The user may wish to configure an output as FailSafe that is critical to the process or that may present a hazard to personnel or equipment. Readback: The state of an output channel is automatically “read back” by input circuitry on the same channel. Readback is used to diagnose and report faults. The user can disable Readback which will, in turn, disable reporting of Readback-related faults (Output Channel failed ON, Output Channel failed OFF, Critical Channel failed ON). 11.2.3 SDM Disc Pulse Out The SDM Discrete Pulse Output (Disc Pulse Out) channel type accepts a boolean (BOOL) variable. The Disc Pulse Out channel type turns on its assigned output for a pre-determined time period (the resolution of the pulse output is ∀10 ms, accurate to within ∀2 ms). The time period is established by the Duration softlist parameter and can be set between 10 ms and 2,000 ms. When the boolean output value sent from the ACM to the SDM module transitions from FALSE to TRUE, the corresponding output turns on for the specified duration. Once the output has been triggered, it can be re-triggered before the end of the pulse duration. 11-2 August 2002 CG39-24 Standard Discrete Module (SDM) Configuring a Disc Pulse Out channel type causes the module to change its method of scanning from synchronous to asynchronous. When the SDM is scanning asynchronously, it writes its outputs and reads its inputs every 10 ms, regardless of the ACM scan rate. This fixed 10 ms scan rate allows the SDM to change the state of its outputs every 10 ms. The following timing diagram shows the output value being sent from the ACM to the SDM. In this example, the ACM scan rate is set to 20 ms; therefore, the ACM can only change the state of the output every 20 ms. The SDM output is configured as a Disc Pulse Out Channel with a duration of 50 ms. Figure 10-1 shows how a FALSE-to-TRUE transition of the ACM output triggers a pulse output. The figure also illustrates that once a pulse output has been triggered, it can be re-triggered before the end of the pulse duration. ACM output (Scan - 20ms) SDM output (Duration = 50ms) 20ms 50ms 50ms 00001138 Figure 11–1 SDM Discrete Pulse Output Timing Diagram Table 11-3 shows the softlist parameters for the SDM Discrete Output Pulse channel type. Table 11–3 SDM Discrete Output Softlist Parameters PARAMETER Duration Readback SELECTION 10 to 2000 ms ENABLED, DISABLED DEFAULT 20 ms DISABLED Duration: The duration of a pulse output channel can be specified between 10ms and 200ms. Since the resolution of the pulse output is ±10ms, duration values will be rounded to the nearest 10ms. For example, if the duration specified is 13ms, the actual pulse will be 10ms long. Likewise, if the duration specified is 18ms, the actual pulse will be 20ms long. Readback: The state of an output channel is automatically "read back" by input circuitry on the same channel. The readback is used to diagnose and report faults. The user can disable readback which will in turn disable reporting of readback related faults (Output Channel failed ON, Output Channel failed OFF). " August 2002 11-3 Standard Discrete Module (SDM) CG39-24 !Notes 11-4 August 2002 CG39-24 Standard Discrete Module Plus (SDM+) 12.0 Standard Discrete Module Plus (SDM+) The Standard Discrete Module Plus (SDM+) interfaces discrete DC sensors and actuators with the APACS+ control module's IOBUS. The SDM+ provides 32 channels, each of which can be configured to be an input, output, or pulse output. The SDM+’s inputs are current sinking (i.e. the input device is wired between the power supply positive (+) and the I/O terminal). Outputs are sourced (i.e. the output device is wired between the output terminal and the power supply common). A pulsed output is an output channel that is “ON” for a user-defined duration (within the range of 10 to 2000 msec). Two Sequence Of Event (SOE) channel types are provided for recording events that can be collected by Sequence Of Events Recorder function blocks. The data is intended for recording SDM+ I/O channel state changes. This information can then be used for optimizing process operations or for troubleshooting purposes, such as determining the sequence of events that led to specific alarm conditions. All input and output circuits are electrically isolated from the SDM+’s CPU, IOBUS, and ground. In addition, softfuse circuits protect the output channels from short circuits and can be reset locally or remotely. 12.1 SDM+ Module Scope Parameter Table 12-1 shows the Module Scope softlist parameter for the SDM+: Table 12–1 SDM+ Module Scope Parameter PARAMETER ScanRate SELECTION NA DEFAULT NA To view/edit the module scope parameters, place the cursor on the desired module in the module tree and select the Edit, Object/Item menu item. The Hardware Modules dialog box opens. Choose the “Softlist” command button. The Module Scope softlist dialog box opens. ScanRate: This is a read-only parameter that displays the current scan rate of the module. 12.2 SDM+ Channel Types The following channel types are supported for the SDM+ module: • • • • • Disc In Disc Out Pulse Out SOE Disc In SOE Disc Out August 2002 12-1 Standard Discrete Module Plus (SDM+) CG39-24 12.2.1 SDM+ Disc In The Discrete Input (Disc In) channel type returns a boolean (BOOL) variable. Table 12-2 shows the Disc In softlist parameter for the SDM+: Table 12–2 SDM+ Disc In Softlist Parameter PARAMETER InputFaultState SELECTION TRUE, FALSE DEFAULT FALSE InputFaultState: When an input channel has a hardware failure that makes the channel value impossible to discern, the channel will report the value configured in this softlist parameter. 12.2.2 SDM+ Disc Out The Disc Out channel type accepts a BOOL variable. Table 12-3 lists the softlist parameters for the SDM+ Discrete Output channel type. Table 12–3 SDM+ Disc Out Softlist Parameters PARAMETER IOBUSFault FailSafe Readback SELECTION OFF, ON, HOLD_LAST_STATE ENABLED, DISABLED ENABLED, DISABLED DEFAULT OFF DISABLED ENABLED IOBUSFault: Each output can be configured to respond to an IOBUS fault (loss of communications with the controller) in a particular manner. The available fault states are: • • • OFF ON HOLD_LAST_STATE Output is turned off. Output is turned on. Output holds its last value. NOTE All channels power up in the OFF state. FailSafe: Each output can be configured to turn off all module outputs in the event that a channel is intended to be off, but diagnostics have determined that it is on. The user may wish to configure an output as FailSafe that is critical to the process or that may present a hazard to personnel or equipment. Readback: The state of an output channel is automatically “read back” by input circuitry on the same channel. Readback is used to diagnose and report faults. The user can disable Readback, which in turn disables reporting of Readback-related faults (Output Channel failed ON, Output Channel failed OFF, Critical Channel failed ON). 12-2 August 2002 CG39-24 Standard Discrete Module Plus (SDM+) 12.2.3 SDM+ Disc Pulse Out The SDM+ Discrete Pulse Output (Disc Pulse Out) channel type accepts a boolean (BOOL) variable. The Disc Pulse Out channel type turns on its assigned output for a pre-determined time period (the resolution of the pulse output is ∀10 ms, accurate to within ∀2 ms). The time period is established by the Duration softlist parameter and can be set between 10 ms and 2,000 ms. When the boolean output value sent from the ACM to the SDM+ module transitions from FALSE to TRUE, the corresponding output turns on for the specified duration. Once the output has been triggered, it can be re-triggered before the end of the pulse duration. Configuring a Disc Pulse Out channel type causes the module to change its method of scanning from synchronous to asynchronous. When the SDM+ is scanning asynchronously, it writes its outputs and reads its inputs every 10 ms, regardless of the ACM scan rate. This fixed 10 ms scan rate allows the SDM+ to change the state of its outputs every 10 ms. The following timing diagram shows the output value being sent from the ACM to the SDM+. In this example, the ACM scan rate is set to 20 ms; therefore, the ACM can only change the state of the output every 20 ms. The SDM+ output is configured as a Disc Pulse Out channel with a duration of 50 ms. Figure 11-1 shows how a FALSE-to-TRUE transition of the ACM output triggers a pulse output. The figure also illustrates that once a pulse output has been triggered, it can be re-triggered before the end of the pulse duration. ACM output (Scan - 20ms) 20ms SDM output (Duration = 50ms) 50ms 50ms 00001138 Figure 12–1 SDM+ Discrete Pulse Output Timing Diagram Table 12-4 lists the softlist parameters for the SDM+ Discrete Output Pulse channel type. Table 12–4 SDM+ Disc Pulse Out Softlist Parameters PARAMETER Duration Readback August 2002 SELECTION 10 to 2000 ms ENABLED, DISABLED DEFAULT 20 ms ENABLED 12-3 Standard Discrete Module Plus (SDM+) CG39-24 Duration: The duration of a pulse output channel can be specified between 10 ms and 200 ms. Because the resolution of the pulse output is ∀10 ms, duration values are rounded to the nearest 10 ms. For example, if the duration specified is 13 ms, the actual pulse is 10 ms long. Similarly, if the duration specified is 18 ms, the actual pulse is 20 ms long. Readback: The state of an output channel is automatically read back by input circuitry on the same channel. Readback is used to diagnose and report faults. The user can disable Readback, which in turn disables reporting of Readback-related faults (Output Channel failed ON, Output Channel failed OFF). 12.2.4 SDM+ SOE Disc In The SDM+ Sequence of Events (SOE) Discrete Input (Disc In) channel type returns SOE information. Table 12-5 lists SOE Disc In softlist parameters for the SDM+: Table 12–5 SDM+ SOE Disc In Softlist Parameters PARAMETER InputFaultState Description EventPriority AlarmState SELECTIONS TRUE, FALSE 28 Character String 1,2,3, or 4 TRUE, FALSE DEFAULT FALSE ‘’ (null string) 1 FALSE InputFaultState: When an input channel has a hardware failure that makes the channel value impossible to discern, the channel reports the value configured in this softlist parameter. Description: This is a description, up to 28 characters, of the channel that is configured to be monitored by the Sequence Of Events Recorder (SOER) block. The description is formatted as a String data type and is inserted as a substring within the Events string of the SOER block. Event Priority: This data is used for establishing an event s priority. Set a channel’s priority from 1 (highest) to 4 (lowest). This priority value can then be used to sort events, as in the case of formattting them for viewing. This priority value is inserted within the Events string of the SOER block. AlarmState: This parameter is used to establish the alarm state of the channel. Choose either state, TRUE or FALSE, that represents an alarm condition. For example, if you set this parameter to TRUE, the channel is said to be in Alarm when the channel s value toggles from FALSE to TRUE. This also inserts an “A” character in the last character position in the Events string of the SOER block. Normally, this character is an “N” character (No alarm). 12.2.5 SDM+ SOE Disc Out The SDM+ SOE Discrete Output (Disc Out) channel type returns SOE information. Table 12-6 lists SOE Disc Out softlist parameters for the SDM+: 12-4 August 2002 CG39-24 Standard Discrete Module Plus (SDM+) Table 12–6 SDM+ SOE Disc Out Softlist Parameters PARAMETER IOBUSFault FailSafe Readback Description EventPriority AlarmState SELECTION OFF, ON, HOLD_LAST_STATE ENABLED, DISABLED ENABLED, DISABLED 28-character string 1, 2, 3, or 4 TRUE, FALSE DEFAULT OFF DISABLED ENABLED ‘’ (null string) 1 FALSE IOBUSFault: Each output can be configured to respond to an IOBUS fault (loss of communications with the controller) in a particular manner. The available fault states are: OFF ON HOLD_LAST_STATE Output is turned off. Output is turned on. Output holds its last value. NOTE All channels power up in the OFF state. FailSafe: Each output can be configured to turn off all module outputs in the event that a channel is intended to be off, but diagnostics have determined that it is on. The user may wish to configure an output as FailSafe that is critical to the process or that may present a hazard to personnel or equipment. Readback: The state of an output channel is automatically “read back” by input circuitry on the same channel. Readback is used to diagnose and report faults. The user can disable Readback, which in turn disables reporting of Readback-related faults (Output Channel failed ON, Output Channel failed OFF, Critical Channel failed ON). Description: This is a description, up to 28 characters, of the channel that is configured to be monitored by the Sequence Of Events Recorder (SOER) block. The description is formatted as a String data type and is inserted as a substring within the Events string of the SOER block. Event Priority: This data is used for establishing an event s priority. Set a channel’s priority from 1 (highest) to 4 (lowest) to sort events, as in the case of formatting them for viewing. This priority value is inserted within the Events string of the SOER block. AlarmState: This parameter is used to establish the alarm state of the channel. Choose either state, TRUE or FALSE, to represent an alarm condition. For example, if you set this parameter to TRUE, the channel is said to be in Alarm when the channel’s value toggles from FALSE to TRUE. This also inserts an “A” character in the last character position in the Events string of the SOER block. Normally, this character is an “N” character (No alarm). " August 2002 12-5 Standard Discrete Module Plus (SDM+) CG39-24 !Notes 12-6 August 2002 CG39-24 Voltage Input Module (VIM) 13.0 Voltage Input Module (VIM) The Voltage Input Module (VIM) interfaces thermocouple and voltage input signals to the control module’s IOBUS. The VIM provides 16 channels, each of which can be configured to be a thermocouple or voltage input. The VIM can accommodate many input types with minimal configuration and high accuracy. Each input is electrically isolated from the module’s CPU, IOBUS, and ground to isolate field faults. In addition, each channel is isolated from other channels. 13.1 VIM Module Scope Parameters Table 13-1 lists the Module Scope softlist parameters for the VIM. Table 13–1 VIM Module Scope Parameters PARAMETER ScanRate LineFreq SharedTC SELECTION NA 50 Hz, 60 Hz YES, NO DEFAULT NA 60 Hz YES To view/edit the module scope parameters, place the cursor on the desired module in the module tree and select the Edit, Object/Item menu item. The Hardware Modules dialog box opens. Choose the “Softlist” command button. The Module Scope Softlist dialog box opens. ScanRate: This is a read-only parameter that displays the current scan rate of the module. In general, the scan rate is the same as the scan rate of the ACM, but may be a multiple of the ACM's scan rate. LineFreq: The module software utilizes a notch filter to reduce noise from AC power sources. Specifying the line frequency of AC power optimizes the filtering algorithm. SharedTC: This parameter only applies when using VIMs in a redundant system. Often one thermocouple is wired to both the primary and the backup VIM. If this is the wiring arrangement for the VIM being configured, specify SharedTC to be YES. If each VIM has its own thermocouples, then SharedTC should be NO. For non-redundant VIM's, specify the default (NO). 13.2 VIM Channel Types The following channel types are supported for the VIM module: • • VIM TIC - Thermocouple Input VIM VIC - Voltage Input August 2002 13-1 Voltage Input Module (VIM) CG39-24 13.2.1 VIM TIC - Thermocouple Input Channel The VIM Thermocouple Input Channel (TIC) type returns a real (REAL) variable. Table 13-2 shows the softlist parameters for the VIM Thermocouple Input channel type. Table 13–2 VIM Thermocouple Input Channel Softlist Parameters PARAMETER TCType EngUnits StepResponseTime Bias MinRange MaxRange Scale_To_Percent Burnout DigFiltTimeCnst SELECTION B, E, J, K, N1, R, S, T, N2 DegºF, DegºC, DegºK, DegºR 0.100 to 40.0 Any Real Number Any Real Number Any Real Number YES, NO DISABLE, UP, DOWN 0.0 to 159.0 sec DEFAULT J DegºC 1.0 0.0 Min. range of TC type selected. Max. range of TC type selected. NO DISABLE 0.016 sec TCType: This parameter specifies the type of thermocouple used (i.e. B, E, J, K, N1, R, S, T, N2) the default is type J. EngUnits: The user can select from the following engineering units: DegºF, DegºC, DegºK, DegºR. Bias: A bias value can be entered to adjust for any known offset (usually due to thermocouple aging). The bias value can be any real number and is added to the scaled thermocouple reading. MinRange: MinRange is an optional parameter that allows the user to specify a minimum operating value in EngUnits. If the reading drops below this value, an underrange error is reported. The MinRange can be any real number. MaxRange: MaxRange is an optional parameter that allows the user to specify a maximum operating value in EngUnits. If the reading goes above this value, an overrange error is reported. The MaxRange can be any real number. Scale_To_Percent: This is a Boolean softlist parameter whose default value is FALSE. Burnout: The user can specify burnout detection or open circuit detection for a thermocouple: DISABLE No burnout or open circuit detection UP Return maximum operating value for TIC type selected DOWN Return minimum operating value for TIC type selected 13-2 August 2002 CG39-24 Voltage Input Module (VIM) DigFiltTimeCnst: Digital filtering can be applied to thermocouple input signals to reduce the effects of electrical noise. The digital filter is a first-order lag, adjustable for time constants of 0.0159 to 159.0 seconds. Equivalent breakpoint frequencies are 10.0 to 0.001 Hz. The default value can be increased for noisy signals. StepResponseTime: This parameter determines the time for the channel to fully respond to a step input. A longer StepResponseTime provides higher resolution and better repeatability of the signal. 12.2.2 VIM VIC - Voltage Input The VIM Voltage Input Channel (VIC) type returns a real (REAL) variable. Table 13-3 lists the softlist parameters for the VIM Voltage Input channel type. Table 13–3 VIM Voltage Input Softlist Parameters PARAMETER InputRange Custom_Range_Low Custom_Range_High MinScale MaxScale EngUnits StepResponseTime DigFiltTimeCnst SELECTION VDC1to5, VDC0to5, VDCNeg10to10, VDCNeg5to5, VDCNeg1to1, Custom -10 to 10 -10 to 10 Any Real Number Any Real Number in, ft, mm, cm, m, in3, ft3, bbl, ml, liter, m3, lb, ton, mol, g, kg, ft/sec, m/sec,ft/sec2, msec2, DegF, DegR, DegC, DegK, psi, psia, psig, InH2O, InHg, ATM, kPa, kPaa, kPag, mmHg, kg/cm2, mbar, bar, lb/ft3, g/cm3, kg/m3, mol/m3, ft3/lb, m3/kg, ppm, pH, PPH, KPPH, t/day, kg/hr, kg/day, gal/min, GPM, GPH, GPD, ACFM, ACFH, SCCM, SCFH, SCFM, MCFH, yd3/hr, yd3/day, BPD, gal/hr, gal/day, m3/hr, m3/day, l/min, l/hr, l/day, mV, Volts, mA, AMPS, Ohms, mhos, W, kW, MW, Btu, Btu/SCF, Btu/lbm, Btu/hr, hp, bhp, vars, VA, kVA, joules, Percent, pulses, Hz, rpm, deg, rad, cal, cal/SCF, cal/hr, cal/lbm, kcal, kcal/SCF, kcal/hr, kcal/lbm 0.050 to 2.000 sec. 0.0 to 159.0 sec. DEFAULT VDC1to5 0 0 0.0 100.0 Percent 1.0 0.016 InputRange: VIC channels are able to read any voltage between -10 and +10. The module utilizes auto-ranging circuitry to provide high resolution even at millivolt levels. For scaling and diagnostic purposes, the range of values being measured by the channel must be specified. Several standard ranges are selectable from a list, or, a custom range can be selected by specifying "Custom" for the InputRange and editing Custom_Range_Low and Custom_Range_High values. August 2002 13-3 Voltage Input Module (VIM) CG39-24 Custom_Range_Low: This is an optional parameter that allows the user to specify a minimum input range in volts. If the reading drops below this value, an underrange error is reported. This parameter is only used when InputRange is specified as “custom.” Custom_Range_High: This is an optional parameter that allows the user to specify a maximum input range in volts. If the reading goes above this value, an underrange error is reported. This parameter is only used when InputRange is specified as “custom.” MinScale: The module will linearly scale raw data (volts) to engineering units for each channel. The scaling algorithm uses the MinScale/MaxScale parameters set by the user. For example, given a MinScale of 0.0, a MaxScale of 100.0, and an InputRange of 1-5 volts, if the input to the channel is 3 volts, the scaled value will be 50.0. MinScale can be any real number (REAL numbers are valid between -3.4028E38 and +3.4028E38.). MaxScale: MaxScale can be any real (REAL) number. EngUnits: Engineering units for the scaled value can be selected from a list of common engineering units. DigFiltTimeCnst: This parameter sets the time constant of a low-pass digital filter applied to the input data. This filter reduces non-repetitive noise from the input data and can be disabled by setting this parameter to 0.0. StepResponseTime: This parameter sets the length of a moving-average digital filter applied to the input data. StepResponseTime determines the time to fully respond to an input step. Increasing this parameter reduces periodic or repetitive noise and improves repeatability and resolution. The recommended setting for this parameter is between 0.5 and 4.0 seconds. " 13-4 August 2002 CG39-24 PROFIBUS Fieldbus Module (PFM) 14.0 PROFIBUS Fieldbus Module (PFM) The PROFIBUS Fieldbus Module (PFM) creates a seamless interface between an APACS+ control system and PROFIBUS DP (Decentralized Periphery) devices. This interface maps PROFIBUS devices to I/O channels in an APACS+ environment, extending the domain of ProcessSuite process automation software, including the R4 Framework, an advanced HMI (human-machine interface). The PFM makes it possible for control architectures to include proven APACS+ hardware and software as well as third-party PROFIBUS field devices. 14.1 PFM Channel Types In the PFM, channel types refers to 4-mation I/O channels. PROFIBUS data types refers to data and data structures defined by PROFIBUS specifications. Channels in parentheses (X) are default mappings. If in 4-mation you define a channel as an analog input, for example, the default PROFIBUS data structure is a DP Float (DP floating point value). Table 14–1 Data to Channel Type Mapping PROFIBUS Data Types PA BOOLEAN DP BOOLEAN DP UINT8 DP UINT16 DP UINT32 DP INT8 DP INT16 DP INT32 DP Float PA Float PFM Channel Types Analog Analog BOOLEAN BOOLEAN Packed In out In Out Discrete In X X X (X) X X X X X X (X) X X X X X (X) X X X (X) X (X) X Packed Discrete Out (X) X 14.2 PFM Module Scope To examine the softlist parameters that apply to the entire module: 1. 2. 3. 4. 5. In 4-mation, open the application and display the module tree. Select the PFM module. Select Edit > Object/Item. Select PFM1 Select Softlist… A window displays the softlist parameters for the module. August 2002 14-1 PROFIBUS Fieldbus Module (PFM) CG39-24 ProfiBitRateKbps—a read-only softlist parameter that corresponds to DP baud rate and is given in kbps (default: 1500.0 kbps) The remaining parameters are reserved for future use. 14.3 PFM I/O Channel Softlist Parameters I/O channel softlist parameters enable 4-mation to translate between raw binary field I/O and three supported 4-mation channel types: • Boolean • Packed Discrete • Analog Softlist parameters vary according to the channel type. DP_Slave_Addr—default is 126, which must be changed to the PROFIBUS address assigned to the device. All the APACS+ channels mapped to a multichannel PROFIBUS device have the same DP_Slave_Addr. Byte_Offset—The Byte_Offset is the distance in bytes between the beginning of an input or output data block in the PFM and the first byte of the channel of interest. The procedures for determining the Byte_Offset for input channels and for output channels are based upon similar underlying principles. For each of its DP slaves, the PFM allocates an input block and output block in its memory. A DP device presents its inputs to the PFM in an unstructured I/O string not longer than 244 bytes. The PFM extracts input data from the string and stores it in its input block it has allocated for the device. The block is uniquely identified by the DP slave address of the device that provides the data. The location and length of individual channel data in the block is determined by three softlist parameters: DP slave address of the DP device, the PROFIBUS data type, and the Byte_Offset. For input channels, the Byte_Offset points to the first byte of the channel’s data in the PFM input block for the device. For output channels, the Byte_Offset points to the first byte of a channel’s output data in the output block. Determining the byte offset so that you can set a channel’s softlist parameters requires an understanding of the device supplying or receiving data. In the following illustration, an ET200M, a DP slave that connects with a variety of multichannel I/O modules, has a PROFIBUS DP address of 9. The ET200M is connected to three modules, a 4 channel analog input module (4AI), a 4 channel analog output module (4AO), and another 4 channel input module (4AI). The data type for the analog channels is signed 16-bit integer (each channel is 2 bytes long). Given the DP address of the module and the PROFIBUS data type, the Byte_Offset parameter identifies the beginning of individual channel data in the PFM block. As this illustration shows, the PFM block for input channels is separate and distinct from the PFM 14-2 August 2002 CG39-24 PROFIBUS Fieldbus Module (PFM) block for output channels. Note, too, that although the input modules are not contiguous, there are no gaps in the input data block. Byte_Offset 0 DP 2 4 6 8 10 12 14 1 Analog output module Signed 16 bit integers (2 bytes each channel) 9 ET200M 0 2 4AI 4 4AO 4AI 2 Analog input modules Signed 16 bit integers (2 bytes each channel) 6 8 10 12 14 Byte_Offset Figure 14–1 Byte_Offset for Typical Input and Output Block A DP/PA link is another common DP device that sends and receives an I/O string. In the case of the DP/PA link, downstream PA devices supply or receive the I/O data. In the case of PA devices connected to the PFM through a DP/PA link, the PA input device with the lowest PROFIBUS address has its data stored in the input block of the PFM at Byte_Offset 0. The next PA input device on the bus, in order of ascending PROFIBUS address, has a Byte_Offset equal to the bytes used by the first device. The third input device has a Byte_Offset equal to the bytes used by the first two devices, and so forth. Byte_Offset for output devices is calculated in the same way. In the illustration below, the DP/PA link device has a PROFIBUS address of 11. The addresses of the PA devices (5, 7, and 8) must be unique to their PA bus, and there may be gaps. In the illustration, the data type of each PA device is a PA floating point structure, which consists of 4 bytes of data and 1 byte of status per channel. The Byte_Offset for the channel associated with the PA address 5 is 0, the Byte_Offset of device with address 7 is 5, and the Byte_Offset of the device with address 8 is 10. See Figure 14–2 DP 3 PA Inputs PA floating point structures (4 bytes data + 1 byte status) 11 DP/PA PA 5 0 7 5 8 10 Byte_Offset August 2002 14-3 PROFIBUS Fieldbus Module (PFM) CG39-24 Figure 14–2 Byte_Offset for Typical Input String Input and output data blocks in the PFM are distinct and independent of one another. The Byte_Offset for an input channel is thus independent of the Byte_Offset for an output channel. The COM PROFIBUS program provides a useful tool for determining or confirming Byte_Offset: 1. With the PROFIBUS network configured through COM PROFIBUS and Simatic PDM, open COM PROFIBUS and either open the current configuration or import it from the DP master 2. Select the DP/PA link. 3. From the menu bar select Services > Observe/Control/Inputs/Outputs. The resulting display shows the current value in bytes of PA devices connected to the DP/PA link. You can count the bytes of input or output preceding a device of interest to determine the device’s Byte_Offset. Keep in mind that the data stream from a PA device includes one byte of status per channel. The illustration below shows data input from two PA floating point devices, both providing four bytes in data and one byte of status (for example, 80 hex). In the example, the PROFIBUS PA address of the first device is 5, so the device is located in position 2 (if its PROFIBUS address were 3, the lowest permissible address for a PA device connected to a DP/PA link, the device would be located in position 0 ). The Byte_Offset of the input channel of the first device, regardless of its address, is always 0. The Byte_Offset of the input channel of the next device (in position 3) is 5, which is the number of input bytes preceding it. If there were a device in position 4, the Byte_Offset for its input channel would be 10, again determined simply by counting the preceding input bytes. See Figure 14–3. Figure 14–3 Using COM PROFIBUS to Determine Byte_Offset Profibus_Slot_Number—in devices with more than one slot (module), the slot number identifies the slot if a PROFIBUS diagnostic message is reported. The Profibus_Slot_Number parameter has no effect on data I/O; it is used only for APACS error reporting. Profibus_Ch_Number—in devices or modules with more than one channel, the channel number identifies the channel if a PROFIBUS diagnostic message is reported. The Profibus_Ch_Number parameter has no effect on data I/O; it is used only for APACS error reporting. 14-4 August 2002 CG39-24 PROFIBUS Fieldbus Module (PFM) PA_SlaveAddr—default is 0, and the parameter is only applicable for PA devices connected to the PFM by a DP/PA link. The valid range is 0 through 125, corresponding to the PROFIBUS address of the PA device. ProfiDataType—(default in parentheses). Table 14–2 show available PROFIBUS data types and lengths for PFM channels. Table 14–2 ProfiDataType SoftList Parameters PFM Channel Length (bytes) ProfDataType Analog input (DP INT16) Analog output (DP INT16) BOOLEAN input (DP UINT8) BOOLEAN output (DP UINT8) Packed Discrete Input (DP UINT8) Packed Discrete Output (DP UINT8) DP UINT8 DP UINT16 DP INT8 DP INT16 DP INT32 DP Floating Point PA Floating Point Structure DP BOOLEAN PA BOOLEAN structure DP INT8 (as packed discrete) DP INT16 (as packed discrete) DP UNIT8 DP UNIT16 1 2 1 2 4 4 5 1 2 1 2 1 2 BitNumber—default is 0, applicable only for BOOLEAN channel types mapped to PROFIBUS integer types. The bit number corresponds with the position of the data in the 8 or 16 bit data structure. Valid bit numbers range from 0 to 15, where 0 represents the first bit, and corresponds to labeling on commonly used DP discrete modules. Figure 14–4shows a how a single BOOLEAN value is stored in a 2-byte packed discrete value. The value of the BOOLEAN channel at BitNumber 10 is 1 0 0 0 1 0 1 0 0 1 1 1 0 0 0 1 0 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0 BitNumber Figure 14–4 BitNumber in a Packet Discrete Data Type August 2002 14-5 PROFIBUS Fieldbus Module (PFM) CG39-24 14.3.1 BOOLEAN Input and Output Channels Table 14–3 BOOLEAN Input and Output Channels SoftList Parameters Parameter BitNumber DP_Slave_Addr Selection 0-15 1-125 (valid range differs from default value, which must be changed) Byte_Offset 0-243 Profibus_Slot_Number 0-63 Profibus_Ch_Number 0-63 ProfiDataType DP BOOLEAN PA BOOLEAN Structure DP UINT8 DP UINT16 PA_SlaveAddr PA_Status (input:read only, output: read/write 0-255) USINT Default 0 126 0 0 0 DP UINT8 0 128 14.3.2 Packed Discrete Input and Output Channels Table 14–4 Packed Discrete Input and Output SoftList Parameters Parameter DP_Slave_Addr Selection 1-125 (valid range differs from default value, which must be changed) Byte_Offset 0-243 Profibus_Slot_Number 0-63 Profibus_Ch_Number 0-63 ProfiDataType ProfiPackDisc_DTYP DP UINT8 DP UINT16 Default 126 0 0 0 DP UINT8 EngUnits: Engineering units for the scaled value can be selected from a list of common engineering units. DigFiltTimeCnst: (Input only) Digital filtering can be applied to analog input signals to reduce the effects of electrical noise. The digital filter is a first-order lag, adjustable for time constants of 0.0159 to 159.0 seconds (0.0 disables the filter). Equivalent breakpoint frequencies are 10.0 to 0.001 Hz. The default value can be increased for noisy signals. Figure 14–5shows the step release time of the digital filter. 14-6 August 2002 CG39-24 PROFIBUS Fieldbus Module (PFM) Step Response Time of Digital Filter Scan Rate = 100ms T (DigFiltTimeCnst) = 1.0 sec. 20 15 mA 14 (63%) Filter Input Filter Output 10 5 0 0 1 T 2 3 4 5 6 7 Time (seconds) Figure 14–5 Step Time Response of Digital Filter 14.3.3 Analog Input and Output The PFM Analog input and output channel types use real (REAL) variables. The softlist parameters Bias, Min_Scale, Max_Scale, RawLo, and RawHi are all interrelated by equations provided in subsection 14.4. August 2002 14-7 PROFIBUS Fieldbus Module (PFM) CG39-24 Table 14–5 shows the softlist parameters for the analog channel types. Table 14–5 Analog Input and Output SoftList Parameters Parameter Min_Scale Max_Scale EngUnits RawLoCounts Selection Any Real Number Any Real Number in, ft, mm, cm, m, in3, ft3, bbl, ml, liter, m3, lb, ton, mol, g, kg, ft/sec, m/sec,ft/sec2, msec2, DegF, DegR, DegC, DegK, psi, psia, psig, InH2O, InHg, ATM, kPa, kPaa, kPag, mmHg, kg/cm2, mbar, bar, lb/ft3, g/cm3, kg/m3, mol/m3, ft3/lb, m3/kg, ppm, pH, PPH, KPPH, t/day, kg/hr, kg/day, gal/min, GPM, GPH, GPD, ACFM, ACFH, SCCM, SCFH, SCFM, MCFH, yd3/hr, yd3/day, BPD, gal/hr, gal/day, m3/hr, m3/day, l/min, l/hr, l/day, mV, Volts, mA, AMPS, Ohms, mhos, W, kW, MW, Btu, Btu/SCF, Btu/lbm, Btu/hr, hp, bhp, vars, VA, kVA, joules, Percent, pulses, Hz, rpm, deg, rad, cal, cal/SCF, cal/hr, cal/lbm, kcal, kcal/SCF, kcal/hr, kcal/lbm INT RawHiCounts INT DigFiltTimeCnst (input only) Bias DP_Slave_Addr 0.0 to 159.0 sec Byte_Offset Profibus_Slot_Number Profibus_Ch_Number ProfiDataType PA_SlaveAddr PA_Status Any Real Number 1-125 (valid range differs from default value, which must be changed) 0-243 0-63 0-63 DP UINT8 DP UINT16 DP UINT32 DP INT8 DP INT16 DP INT32 DP Floating Point PA Floating Point Structure (input:read only; output:read/write, 0-255)USINT Default 4 20 mA -27648 (0x9400) 27648 0x6c00) 0.0 0.0 126 0 0 0 DP INT16 0 128 14.4 Mapping Analog Channels to PROFIBUS Integer Data Types Bias: The user can enter a bias (in engineering units) on a per channel basis to compensate for known offsets. The bias value is added to a scaled input or subtracted from a scaled output. 14-8 August 2002 CG39-24 PROFIBUS Fieldbus Module (PFM) Min_Scale/ Max_Scale: The module linearly scales raw data to engineering units for each channel. The scaling algorithm (equation below) uses the Min_Scale/Max_Scale parameters set by the user. For example, given a 4 to 20 mA input, a MinScale of 0.0 and a MaxScale of 100.0; if the input to the channel is 12 mA, the scaled value is 50.0. Min_Scale and Max_Scale can be any real (REAL) number (Real numbers are valid between 3.4028E38 and +3.4028E38.) RawLoCounts: specified by the user to define the value of the associated process variable. The default is –27648 (0x9400) when the channel value equals min scale. RawHiCounts: specified by the user to define the value of the associated process variable. The default is 27648 (0x6c00) when the channel value equals max scale. The following equations describe how analog values are mapped to integers. The result of equation (1) is used in equations (2) and (3). APACS output analog channel mapped to PROFIBUS integer analog output: counts per unit = (RawHiCount s − RawLoCount s ) (Max_Scale − Min_Scale ) (1) PROFIBUS value = RawHiCounts − ((Max_Scale − ( Analog value − Bias ))∗ counts per unit (2) NOTE MaxScale may be less than MinScale, as might be required by a “reverse acting” device such as a reverse acting valve. APACS analog input channels mapped to PROFIBUS integer analog input: (RawHiCounts − PROFIBUS value ) + Bias APACS value = Max_Scale − counts per unit (3) 14.5 Out of Range Errors Range is defined as Max_Scale – Min_Scale. The 4-mation program sets an out-of-range error for a channel value that exceeds the absolute magnitude 0.05 x range (5%). A built-in hysteresis mechanism prevents the error from clearing until the channel value falls to the absolute magnitude of 0.03 x range (3%). See Figure 14–6. August 2002 14-9 PROFIBUS Fieldbus Module (PFM) CG39-24 Out of range error 5% Error cleared 3% Range = (Max_Scale - Min_Scale) 5% 3% Figure 14–6 Out of Range Error and Hysteresis " 14-10 August 2002