User Manual - Schneider Electric SCADA & MES Global Support
Contents
1. GODO Advanced Technology Systems Document Title IEC870 5 101 Driver for Citect User Manual Revision Revision 107 Revision Date April 16 2002 By Paul Whitfield File Name IEC870t_Driver_Manual doc Copyright This document contains proprietary information of Microsol Limited None of the information contained in this document may be reproduced or disclosed to others without written authorisation by Microsol Limited The information in this document is subject to change without prior notice and should not be construed as a commitment by Microsol Microsol do not assume responsibility for any errors that may be in this document feat SCH Advanced Technology Systems Date Rev 106 107 Date Rev Author SK SK SK SK PSW PSW PSW PSW Reviewer IEC870t Driver Manual doc Microsol IEC870 5 101 Driver for Citect User Manual Revision 107 Revision History Comments Created and initial releases Changed company name to Microsol and correct various problems Changed numbering to be V105 rather than 005 Reorganised structure of document Added alarm server description Added description of SOE processing Removed SOEQUE and PROCESSCOS as they are not supported Incorporated review comments Added support for short floating point measurands Added DefaultAnalogSOEMode parameter Added TimeoutCount parameter Ad2. the value of the SOE and the time to the second tag i e the time stamp For example to configure an alarm for a single digital input with Information Object Address IOA equal to 400 Create variable tag VALUE with address SD400 Create variable tag TIMESTAMP with address TTDT400 Create a time stamped alarm ALARM with variable tag VALUE and time TIMESTAMP Alarm pages and Alarm summary pages can be created from the standard Citect templates 8 2 Driver Statistics The following special counters are accumulated by the driver They can be viewed at run time by typing page Driver in the Kernel window to display the Driver window and pressing the down arrow or v key in that window to activate Verbose mode Data CRC Error The number of messages received that had a bad checksum Unit Offline The number of times any device has been made off line Negative Reply Rx The number of times a device has indicated in a Command Response that there was something wrong with the command sent to it 3 4 NOT IMPL Replies The number of times the driver has received a NOT IMPLEMENTED message 7 5 NOT AVAIL Replies The number of time the driver has received a NOT AVAILABLE message 6 The number of times the driver has received a BUSY message FCB Errors The number of times the driver has received a message with an incorrect Frame Control Bit FCB this indicates that not all messages are being received correctly Unknown Addr
3. Citect User Manual Advanced Technology Systems Revision 107 Class2PollTimeMs How often to check for Class 2 data msec 0 switches off polling This parameter is ignored in Balanced mode no polling Class1PollTimeMs 5000 0 32767 How often to check for Class 1 data msec 0 switches off polling This parameter is ignored in Balanced mode If the RTU has class one data this is shown in the response to the poll for class 2 data in this case the driver will automatically poll for class 1 data GIPollTimeSec 3600 0 32767 How often to perform General Interrogations seconds 0 switches off polling A General Interrogation flags the device to return the current state of all points General Interrogations should not be necessary except after communications breaks but it s a good idea to perform them occasionally to provide an integrity check of the database CounterPollTimeSec 1800 0 32767 How often to perform Counter Interrogations seconds 0 switches off polling A Counter Interrogation flags the device to return the current state of all counters in Class 1 data which normally only contain changes to data Some devices will return counter changes in Class1 events in which case frequent Counter Interrogations are not necessary Other devices return counter data ONLY in response to Counter Interrogations so the polling rate needs to be set
4. Regulating Step Command No additional definition Short Duration Pulse Long Duration Pulse Persistent Output 31 Reserved as per IEC Standard RON O The default mode is specified by the driver configuration parameter DefaultDOQual Set Point Command 0 Default 1 127 Reserved as per IEC Standard SELEX Select Execute mode for output points leave blank for other point types 0 Direct execute single stage 1 Select Execute three stage The default is specified by the driver configuration parameter DefaultSEMode SOEENABL SOE Enable flag for input points only leave blank for other point types Enables or Disables SOE reporting for this point 0 SOEs Disabled 1 SOEs Enabled The default is specified by the driver configuration parameter DefaultSOEMode 4 2 1 Configuration of Double Digital Outputs In many cases the IOA configuration file won t need to be used However all Digital Outputs default to SDO Single Digital Output so any DDOs Double Digital Outputs or RSOs Regulating Step Outputs needed must be configured in the IOA configuration File If for example one Select Execute Short Pulse DDO with IOA 1221 is to be configured on an RTU with Common address 43 on the Serial1 channel then put one row in the IOA configuration File as follows CHANNEL COMMADDR IOA TYPE QUALIF SELEX SOEENABL Serial1 1221 DDO 1 1 0 The QUALIF and SELEX fields will ov
5. Rx The number of times the driver has received a message containing invalid address information indicates that the slave device may be incorrectly configured Pea The number of times that the driver has lost data because its internal buffers have become full 10 Intercharacter The number of times message have been rejected because the time timeouts between bytes in a message was too large This may indicate that communication parameters need to be adjusted 1 1 SOE Q Length The number of SOE buffers currently used When no changes are occurring this value will be equal to the number of SOE tags in the system If this number exceeds the configured number of SOE IEC870t_Driver_Manual doc Last Revised 16 April 2002 Page 26 of 38 Microsol ONO L IEC870 5 101 Driver for Citect User Manual enee Technology Systems Revision 107 pd Cd buffers datawillbelost S S 2 aco messages that have been transmitted since Citect started ae Ve een transmitted since Citect started been transmitted since Citect started transmitted since Citect started transmitted since Citect started IEC870t_Driver_Manual doc Last Revised 16 April 2002 Page 27 of 38 Mi I 1 ONO L IEC870 5 101 Driver for Citect User Manual Advanced Technology Systems Revision 107 9 Protocol Issues There are some ambiguities in the IEC standards that leave room for minor interope
6. as in the protocol s Clock Synchronisation command Currently the driver converts these into 32 bit integers containing milliseconds since midnight as supported by Citect HresType 7 Citect has built in support for time stamped alarm transitions but not for other time stamped data However T101 extends time stamping to potentially any incoming data Citect s usual method for obtaining timestamps is as follows e The value of the datum is repeatedly read in the alarm scan e When it changes Citect then reads its timestamp e The driver takes this as an indication that this state change has been processed and can be popped from its queue The above is currently implemented by Citect as part of its alarm handling However for non alarm points it should be implemented by application CiCode 6 2 Time Stamped Data Queues In some applications there may be a need to receive and store regularly polled data even when its value doesn t change for example hourly meter readings The hourly readings may need to be recorded in a database as discrete readings even if sequential readings for a point have identical values To allow for this an optional timestamp method has been allowed for as follows e The timestamp of the datum is repeatedly read e When it changes Citect then reads its value e The driver takes this as an indication that this state change has been processed and can be popped from its queue Note that for either met
7. is being brought on line Note The lower the timeout value the more quickly units can be brought back on line If the timeout it is set too low then Citect may begin reading data from the driver before it is all refreshed and data not yet valid errors will occur 3 4 Alarm Server Configuration Parameters Alarm The following two parameters for the alarm server should be set see the Citect documentation for more information HresType 7 Twenty four hour millisecond timer stored as decimal Currently this is the only time stamp format supported by the IEC 870 5 101 driver HighResOff 1 Use millisecond accuracy for active and inactive alarm transitions the default setting is to only time stamp alarm active transitions IEC870t_Driver_Manual doc Last Revised 16 April 2002 Page 15 of 38 Mi I 1 ONO L IEC870 5 101 Driver for Citect User Manual Advanced Technology Systems Revision 107 4 Optional Configuration Files 4 1 Unit Configuration File lecUnit dbf The IEC870 5 101 protocol provides three different levels of addressing The Link address This is the physical address of the device that the Citect master will talk to at the data link level i e that the Citect master is physically linked to It roughly corresponds to a Citect I O Device Address The Common address The logical address of the device that the Citect master will communicat
8. project that utilises the driver To install this project restore the project as described in the Citect user documentation You should refer to the IEC 870 standards for more information about the protocol and its terminology IEC870t_Driver_Manual doc Last Revised 16 April 2002 Page 7 of 38 Mi I 1 ONO L IEC870 5 101 Driver for Citect User Manual Advanced Technology Systems Revision 107 3 Driver Configuration Parameters Several configuration parameters that control the driver s operation are available These parameters can be set either by e directly editing the citect ini file in the windows directory using a text editor or e by editing the parameter using the system gt parameters menu option from the project editor Note Parameter in the Citect ini file takes precedence over parameters set in the project database See the Citect documentation section on parameters for more information For parameters that are configured on a per channel basis these are indicated by PortName in the parameter name the first part of parameter name must match name of the IO channel configured for the channel To add comments in the citect ini file put a character in the first column of the line 3 1 Citect Default Parameters The default and recommended values for the standard Citect driver parameters are as follows Portname Block 256 Delay 1 MaxPending 2
9. s _ 9600 bit s 19200 bit s 38400 bit s Page 32 of 38 Mi I 1 ONO L IEC870 5 101 Driver for Citect User Manual Advanced Technology Systems Revision 107 8 3 Link Layer Network specific parameter Frame format FT 1 2 single character 1 and the fixed time out interval are used exclusively in this companion standard Link Transmission Procedure Address Field of the Link a Balanced transmission teil Not present balanced transm only Wi Unbalanced transmission One octet Go Two octets Frame Length Structured 262 Max length L number of octets Unstructured 8 4 Application Layer Transmission Mode for Application Data Mode 1 Least significant octet first as defined in clause 4 10 of IEC 870 5 4 is used exclusively in this companion standard Common address of ASDU System specific parameter One octet ei Two octets Information Object Address System specific parameter One octet Structured Two octets bi Unstructured Three octets Cause of Transmission System specific parameter One octet Two octets with originator address IEC870t_Driver_Manual doc Last Revised 16 April 2002 Page 33 of 38 Mi I 1 ONO L IEC870 5 101 Driver for Citect User Manual Advanced Technology Systems Revision 107 Selection of Standard ASDUs Process information in monitor direction station
10. this bit is undefined if timestamp from significant PC i e bit 14 is set Note When the StoreDigitallnQual Parameter is zero The IEC standards specify that the two bit DPI field is Indeterminate or Intermediate when DPI 0 and Indeterminate when DPI 3 To determine the value of the DPI from D and QD If QD Bit 1 and Bit 2 are not set and D is 0 then DPI 1 If QD Bit 1 and Bit 2 are not set and D is 1 then DPI 2 If QD Bit 2 is set then DPI 0 If QD Bit 3 is set then DPI 3 On start up all input IOAs are marked Not topical and stay that way until the driver receives data for them at which time the Not topical flags in this data are used IOAs that don t exist on a device will remain marked Not topical forever Incoming protocol messages generally have Quality Descriptors associated with them that include indications of the data being invalid or not topical out of date These indications are returned from the driver to the Citect kernel in Citect Quality Descriptor pseudo registers one per input data point IEC870t_Driver_Manual doc Last Revised 16 April 2002 Page 19 of 38 Mi I 1 ONO L IEC870 5 101 Driver for Citect User Manual Advanced Technology Systems Revision 107 Other indications such as transient for integer inputs or intermediate for DDIs do not come from the protocol data packet s Quality Descriptor b
11. 0 5 101 Driver for Citect User Manual Advanced Technology Systems Revision 107 Process information in control direction station specific parameter lt 45 gt Single command C_SC_NA 1 CH lt 46 gt Double command C_DC_NA1 ia lt 47 gt Regulating step command C_RC_NA_1 all lt 48 gt Set point command normalized value GC SE NA 1 Wei lt 49 gt Set point command scaled value C SE NB 1 lt 50 gt Set point command short floating point value C_SE_NC_1 lt 51 gt Bitstring of 32 bit C BO NA 1 System information in monitor direction station specific parameter HE lt 70 gt End of initialization M EI NA 1 IEC870t Driver Manual doc Last Revised 16 April 2002 Page 35 of 38 Microsol ONO L IEC870 5 101 Driver for Citect User Manual Hadvanced Technology Systems Revision 107 System information in control direction station specific parameter lt 100 gt Interrogation command GC IC NA 1 lt 101 gt Counter interrogation command C CINA 1 lt 102 gt Read command C RD NA 1 all lt 103 gt Clock synchronisation command GC CS NA 1 KH lt 104 gt Test command CTS NB 1 lt 105 gt Reset process command C_RP_NC_1 d lt 106 gt Delay acquisition command C_CD_NA_1 Parameter in control direction station specific parameter lt 110 gt Parameter of measured value normalized value P M
12. 4 Float Inputs used for Short Floating Measurand Values Current Value F lt ioa gt F lt ioa1 gt lt ioa2 gt lt ioa3 gt Quality Descriptor Current QD lt ioa gt QD lt ioa1 gt lt ioa2 gt lt ioa3 gt State 7 1 5 Digital Outputs used for Single Command Single Digital Output Double Command Double Digital Output and Regulating Step Command New Value C lt ioa gt C lt ioa1 gt lt ioa2 gt lt ioa3 gt Double Commands are only ever used for trip close operations so only 2 states are valid Hence they will be treated as Single Digital Output points by Citect and translated in the driver 0 becomes 0 1 trip and 1 becomes 1 0 close Regulating Step Commands are similar to Single Commands except that writing a 0 means next step lower and 1 means next step higher The control outputs in the IEC870 5 101 protocol are pure outputs therefore there is no associated quality information 7 1 6 Integer Outputs used for Set Point Command New Value Cl lt ioa gt Cl lt ioa1 gt lt ioa2 gt lt ioa3 gt The control outputs in the IEC870 5 101 protocol are pure outputs therefore there is no associated quality information IEC870t_Driver_Manual doc Last Revised 16 April 2002 Page 24 of 38 Mi I 1 ONO L IEC870 5 101 Driver for Citect User Manual Advanced Technology Systems Revision 107 7 1 7 Force General Interrogation Writin
13. E NA 1 lt 111 gt Parameter of measured value scaled value PMENB 1 lt 112 gt Parameter of measured value short floating point value P_ME_NC_1 lt 113 gt Parameter activation P AC NA 1 File Transfer station specific parameter lt 120 gt File ready FFR NA 1 lt 121 gt Section ready F_SR_NA 1 lt 122 gt Call directory select file call file call section F_SC NA 1 lt 123 gt Last section last segment FLS NA 1 _ lt 124 gt Ack file ack section FAF NA i lt 125 gt Segment FSGNA 1 ze lt 126 gt Directory FDRTA1 IEC870t Driver Manual doc Last Revised 16 April 2002 Page 36 of 38 est SC H SS Advanced Technology Systems 8 5 Basic Application Functions Station Initialisation station specific parameter General Interrogation system or station specific parameter OOO E Remote initialisation global group 1 DI group 7 group 2 group 8 group 3 ei group 9 group 4 group 10 group 5 cl group 11 group 6 group 12 Clock Synchronisation station specific parameter Clock synchronisation Command Transmission object specific parameter IEC870t Driver Manual doc Direct command transmission Direct set point command transmission No additional definition WW Microsol IEC870 5 101 Driver for Citect User Manual Revision 107 group 13 group 14 group 15 group 16 ODO addresses per
14. Manual Advanced Technology Systems Revision 107 IEC870t_Driver_Manual doc Last Revised 16 April 2002 Page 31 of 38 LL Advanced Technology Systems Microsol 1 ONO IEC870 5 101 Driver for Citect User Manual Revision 107 Appendix A IEC 870 5 101 Interoperability List The interoperability list refers to section 8 of IEC 60870 5 101 8 1 Network Configuration network specific parameter HE Point to point B Multiple point to point 8 2 Physical layer network specific parameter Transmission Speed Control Direction Unbalanced interchange Unbalanced interchange circuit V 24 V 28 circuit V 24 V 28 Standard Recomm if gt 1200bit s I 100 vits E 2400 bits WW on WW 300bits WW 300 bits Hi 9600 bits 600 bit s E 1200 bit s Transmission Speed Monitor Direction Unbalanced interchange Unbalanced interchange circuit V 24 V 28 circuit V 24 V 28 Standard Recomm if gt 1200bit s J 100 bits W 2400 bits WW 200bits WW Asor WW 300 bits Hi 9600 bits 600 bit s 1200 bit s IEC870t Driver Manual doc Last Revised 16 April 2002 HE Multipoint party line Multipoint star Balanced interchange circuit X 24 X 27 L_ 2400 bits 56000 bit s 4800 bits 64000 bit s 9600 bit s 19200 bit s 38400 bit s Balanced interchange circuit X 24 X 27 2400 bits 56000 bits 4800 bit s 64000 bit
15. Polltime 100 msec Timeout 2000 2 sec Retry 1 WatchTime 30 sec Warning The PollTime parameter must NOT be set to zero PollTime defaults to 100 milliseconds Note The optimum value of the timeout is baud rate dependent especially when operating in balanced mode The best value depends on the communication medium being used It is possible for an RTU to send the driver the longest possible unsolicited message while the driver is sending a command IEC870t_Driver_Manual doc Last Revised 16 April 2002 Page 8 of 38 feat SCH Advanced Technology Systems Microsol IEC870 5 101 Driver for Citect User Manual 3 2 General Parameters IEC870T Section Revision 107 The table below outlines the parameters that effect all configured IEC ports DefaultSetPtT ype NORM NORM SCALE Selects whether Set Point Outputs should default to Normalised Value NORM or to Scaled Value SCALE Set Points can be overridden from this default individually in the IOA Configuration File DefaultSEMode Oor 1 Selects whether outputs should default to Direct execute 0 or to Select Execute 1 Outputs can be overridden from this default individually in the IOA Configuration File DefaultDOQual 0120r3 Selects the default Output qualifier for Digital Controls Controls can be overridden from this defaul
16. Sl lt ioa gt TTSiI lt ioa1 gt lt ioa2 gt lt ioa3 gt Time triggered SOE Timestamp TTST lt ioa gt TTST lt ioa1 gt lt ioa2 gt lt ioa3 gt Quality Descriptor SOE Value QDS lt ioa gt QDS lt ioa1 gt lt ioa2 gt lt ioa3 gt IEC870t Driver Manual doc Last Revised 16 April 2002 Page 23 of 38 Microsol 1 ONO L IEC870 5 101 Driver for Citect User Manual Hdvanced Technology Systems Revision 107 In the protocol Step position information is a single byte with the MSB a transient indicator set if equipment is in transient state and the other 7 bits holding a value from 64 to 63 The driver will convert it to a 16 bit signed integer and separate the transient indicator out into the Quality Descriptor 7 1 3 Long Integer Inputs used for Integrated total Counters Current Value L lt ioa gt L lt ioa1 gt lt ioa2 gt lt ioa3 gt Quality Descriptor Current QD lt ioa gt QD lt ioa1 gt lt ioa2 gt lt ioa3 gt State Value triggered SOE Value SL lt ioa gt SL lt ioa1 gt lt ioa2 gt lt ioa3 gt Value triggered SOE ST lt ioa gt ST lt ioa1 gt lt ioa2 gt lt ioa3 gt Timestamp Time triggered SOE Value TTSL lt ioa gt TTSL lt ioa1 gt lt ioa2 gt lt ioa3 gt Time triggered SOE Timestamp TTST lt ioa gt TTST lt ioa1 gt lt ioa2 gt lt ioa3 gt Quality Descriptor SOE Value QDS lt ioa gt QDS lt ioa1 gt lt ioa2 gt lt ioa3 gt 7 1
17. al I O Device Addresses available for use are likewise restricted Given the protocol allows for any 16 bit number to be used as a Link or Common address it may not be possible to enter some addresses into Citect s I O Device Address fields IEC870t_Driver_Manual doc Last Revised 16 April 2002 Page 16 of 38 Microsol 1 ONO L IEC870 5 101 Driver for Citect User Manual enee Technology Systems Revision 107 4 2 IOA Configuration File IECIOA DBF The IEC870T driver provides additional facilities to provide additional addressing information to support the complex addressing provided for by the IEC870 protocol Note You must configure the parameters UselOAConfigFile and IOAConfigFileName correctly before Citect will read the configuration file Output points can be individually operated in one of several possible ways via the protocol s output commands For example a Single Digital Output can be Select Execute or Direct Execute and it can be Short Pulse Long Pulse Persistent or Predefined If a protocol command is sent for an IOA that does not support the specified operation an error will result Consequently there needs to be configuration on a per IOA basis in the driver An optional IOA configuration File by default IECioa dbf will be used which contains one IOA per row Each row configures output qualifiers or the SOE enable flag me
18. as per the required update rate Note that this driver currently does not support getting counter values exactly on o clock etc boundaries such as is needed by some EMS systems etc A fast polling rate would be needed to approach this if counter change events are not sent by the device IEC870t_Driver_Manual doc Last Revised 16 April 2002 Page 10 of 38 Microsol Iesst SC 28 IEC870 5 101 Driver for Citect User Manual Advanced Technology Systems Revision 107 CounterPollType 0120r3 Type of Counter Interrogation message to send This parameter will affect Counter Interrogations done as a regular poll but not those done on demand through the FORCECI output which are always without freeze and reset This parameter can be one of the following 0 no freeze or reset 1 freeze without reset 2 freeze with reset 3 reset only TimeSyncPollTimeSec 1800 0 32767 How often to set a device s time seconds Default is 30 minutes Setting 0 disables time synchronisation TimeSyncOnlnit 1 Oor 1 Whether to set a device s time as it comes on line 1 or not 0 TxTestLink 5000 0 32767 How often to send Test Link messages milliseconds 0 switches off transmitted Test Link messages Note that this has effect only for Balanced Mode because Test Link messages are undefined in Unbalanced Mode and will not be sent Timeou
19. ded StoreDigitallnQual parameter Added description of communication statistics Changed default Intercharacter timeout to 100 ms Added ability to log raw i o to kernel log Added reference to Citect 5 4 Service Pack Cs Approval Release Notes Last Revised 16 April 2002 Page 2 of 38 1 3 4 5 6 7 9 Microsol ONO L IEC870 5 101 Driver for Citect User Manual Kevanced Technology Systems Revision 107 Table of Contents teke lT o tio aS ee ee eh ee ek EP EP SE 5 WAS DriverOpe ratlonsausunandmutikset tende Govt E 5 Getting Started DE 6 2 1 Driver Installationi kunstarter 6 2 2 Determining Driver Copy Protection License key 6 2 3 Adding a New Protocol Entry seenen ee i a ar N a NES 7 2 4 Citect O Forms Configuration dinni eat kine aii eli aia aide eee 7 2 5 Example IEC870T Citect Project A 7 Driver Configuration ParametersS rrrssrrnnnvnnnnvnnnnnvnnnnnnnnnvnnnnnvnnnnnnnnnnnnnnnvnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnn 8 3 1 Citect Default Parameterg AAA 8 3 2 General Parameters IEC870T Section rrnnonnrnnnnrrnnnrrnnnnrnnenvnnnnrrnnnnrnnnnnnnnerrenrrrrrnnrnnrnnnnrenn 9 3 3 Channel Parameters ost g eegente ege eiet 14 3 4 Alarm Server Configuration Parameters Alarm rannnnnannvnnnnrnnnnrrnnnnrnnnnnnnnrrrennnrrnnnnnnnrnnennr 15 Optional Configuration FileS rssrrnnnnvnnnnvnnnnvnnnnnvnnnnnnnnnnnnnnnvnnnnnnnnnnnnnnnvnnnnnnnnnnnnnnnnnnnnn
20. e with at the application level Usually it is the same as the Link address but if the device physically linked to be connected to other devices then the Common address distinguishes between them allowing a particular one to be addressed It also roughly corresponds to a Citect I O Device Address Information Object Address IOA This is the object to be read or written to within the device It corresponds to a Citect Variable Tag Address Catering for both a link address and a common address is done by e By default the Citect I O device address is used as the common address and link address if they are always the same e Where some common and link addresses are different use an address configuration file for the driver that maps Link addresses to Common addresses The Citect I O Device Address will then always be an index that maps to an entry in this configuration file This address configuration file is IECunits dbf by default and is optional An example file is provided with the IEC Driver A Configuration Parameter defines whether this file is to be used If in use ALL units will need to be specified one per row Fields for each row are e WO Device Address an index number referenced from Citect s I O Device Address field e Link address e Common address Note The Citect Knowledge Base indicates that Citect can handle a maximum of 4096 I O Devices It is currently unclear as to whether the actu
21. ermines the expected intercharacter gap However the timeout typically needs to be a bit larger due to timing inaccuracies so 50ms or more is recommended The number of timeouts can be monitored in the driver statistics lt PortName gt AppTimeoutMs 4000 Application level timeout for the device The normal Timeout parameter applies to link level responses but application level data may take longer due to processing taking place in the device This is used for example when waiting for a Select Confirmation after a Control Select has been issued or when waiting for all Interrogation data to arrive lt PortName gt Log Enable logging for RAW communication data for this channel This is useful for debugging communication IEC870t Driver Manual doc Last Revised 16 April 2002 Page 14 of 38 Microsol Iesst SC 28 IEC870 5 101 Driver for Citect User Manual Advanced Technology Systems Revision 107 problems Note This results in a large amount of data being written into the system log and will effect the response time of the driver Note Many but not all IEC 870 5 101 devices will provide an Activation Termination message at the end of Interrogation data so no application timeout is needed Otherwise the timeout will allow the driver to know when all Interrogation data has been received for example GI data when a device
22. erride any default specified in the DefaultDOQual and DefaultSEMode configuration parameters IEC870t_Driver_Manual doc Last Revised 16 April 2002 Page 18 of 38 Microsol Iesst SC 28 IEC870 5 101 Driver for Citect User Manual Advanced Technology Systems Revision 107 5 Configuring IO Points 5 1 Quality Descriptors For IEC870 5 101 protocol the Citect Quality Descriptor word has bits defined as follows 0 least significant For Counters Overflow or counter carry indication For Single Points if the StoreDigitallnQual parameter is 1 this bit contains the current point value For Double Points If the StoreDigitallnQual parameter is set this bit contains the lower bit of the point value DPI 1 Transient for integer inputs For Double Points if the StoreDigitallnQual Parameter is 0 Indeterminate intermediate state for double digital inputs DDI For Double Points if the StoreDigitallnQual Parameter is 1 The upper bit of the point value DPI 2 For Double Points if the StoreDigitallnQual Parameter is 0 Invalid state for double digital inputs DDI 3 Blocked 4 Substituted 5 Not topical 6 Invalid 7 Counter adjusted since last reading 8 12 Counter Sequence number number from 0 to 31 13 Quality Descriptor out of date 14 Timestamp was provided by PC not RTU 15 most Timestamp from RTU has invalid set
23. g 1 to this digital register will force a General Interrogation of the device FORCEGI 7 1 8 Force Counter Interrogation Writing 1 to this digital register will force a Counter Interrogation of the device without freeze or reset of the counters FORCECI 7 1 9 Force Clock Synchronisation Writing 1 to this digital register will force a Clock Synchronisation of the device FORCECS 7 1 10 Counter Freeze Writing 1 to this digital register will perform a counter freeze on the device COUNTFZ 7 1 11 Counter Reset Writing 1 to this digital register will perform a counter reset on the device COUNTRS 7 1 12 Counter Freeze and Reset Writing 1 to this digital register will perform a counter freeze and reset on the device COUNTFZRS IEC870t_Driver_Manual doc Last Revised 16 April 2002 Page 25 of 38 Microsol Iesst SC 28 IEC870 5 101 Driver for Citect User Manual Advanced Technology Systems Revision 107 8 Configuring the Citect Alarm Server 8 1 1 Parameters See section 3 4 Alarm Server Configuration Parameters Alarm 8 1 2 Alarm Points To configure an alarm point first you need to configure the following e Create a variable tag for the value of the SOE i e the value triggered SOE value e Create variable tag for the timestamp value triggered SOE Timestamp e Create atime stamped alarm set the variable to first tag i e
24. group have to be defined Select execute command Select execute set point command C SE ACTTERM used Short pulse duration duration determined by a system parameter in the outstation Long pulse duration duration determined by a system parameter in the outstation Persistent output Last Revised 16 April 2002 Page 37 of 38 Advanced Technology Systems Microsol 1 ONO L IEC870 5 101 Driver for Citect User Manual Revision 107 Transmission of integrated totals station or object specific parameter Counter request Counter freeze without reset Counter freeze with reset Counter reset Addresses per group have to be defined Parameter Loading object specific parameter Threshold value Smoothing factor D Low limit for transmission of measured value High limit for transmission of measured value Parameter Activation object specific parameter LICI CILI General request counter Request counter group 1 Request counter group 2 Request counter group 3 Request counter group 4 Act deact of persistent cyclic or periodic transmission of the addressed object File Transfer station specific parameter File transfer in monitor direction A File transfer in control direction IEC870t Driver Manual doc Last Revised 16 April 2002 Page 38 of 38
25. he online offline status of devices However these two processes are not only linked by the memory image data they are also linked by information about the validity of that data When a unit goes off line all data is marked as not topical Each datum then becomes topical once it has successfully been read from the device The driver is interrupt driven with an interrupt service routine called on data arrival The interrupt routine does validity checking of the data discarding any invalid data then queues it for processing The next poll from Citect to the driver then triggers reading and processing of this queue This is different from most Citect drivers that are either completely poll driven or switch off Citect polls to the driver completely The problem with the latter approach is that interrupt routines become too long and complex and too much code ends up in common between interrupt and normal processing increasing the risk of conflicts Note The outcome of this is that the PollTime parameter should NOT be made zero It can comfortably be made a very small period though as the polling is now an insignificant overhead all it does is check for a non empty receive queue and a non empty send queue PollTime defaults to 100 milliseconds IEC870t_Driver_Manual doc Last Revised 16 April 2002 Page 5 of 38 Mi I 1 ONO L IEC870 5 101 Driver for Citect User Manual Advanced Technology Systems Re
26. hod Quality Descriptor words associated with time stamped data should be read before the driver is signalled to pop the data from the queue Cicode Note This can be achieved by putting a function into the timestamp field of the time stamped alarm The arguments passed into the function are in order Fn QDS ST then the function simple returns the ST but has captured the QDS for later processing An additional consideration with the protocol s extended use of timestamps is in queuing of changes Normally in an SOE enabled driver all time stamped changes are put into the SOE queue Queue entries not retrieved by Citect remain until they time out which isn t usually a problem because time stamped changes will be detected by Citect s alarms scanning IEC870t_Driver_Manual doc Last Revised 16 April 2002 Page 21 of 38 Microsol ONO L IEC870 5 101 Driver for Citect User Manual advanced Technology Systems Revision 107 With the extended use of timestamps in this protocol the SOE queues may be overloaded with unused entries To prevent this points are individually configurable as to whether the driver keeps SOE data for them or not 6 3 SOE Hold Mechanism The driver implements a SOE hold mechanism to provide e efficient memory usage e ensure SOE data is not lost e Support for multiple SOE server tasks The driver will keep the SOE event in its buffer until one of the follo
27. information Example configuration the following entries in the winnt citect ini file in the COMx section will enable COMx logging COMx WritePortName PORT_1 WriteDebugLevel 1 ReadPortName PORT_1 ReadDebugLevel 1 Where PORT_1 is port name as it appears in the Citect gt Communications gt Ports form The logs will be created in data files named after the ports in the windows directory For the example port names above the files created would be WPORT_1 dat RPORT_1 dat WSeriall dat RSeriall dat 11 2 Gathering Information for a Support Request Should a communications problem arise requiring support from Microsol please do as much as possible of the following to help diagnosis e Provide a description of the problem and the circumstances that cause it e Enable COMx logging as described in section 11 1 above and enable driver debug debugstr logging as described in section 1 above then reproduce the problem e Provide the log files produced above e Provide your citect ini e Provide information on configuration of the device including communications parameters e g baud rate and IEC parameters e g IOA length etc e Try to reproduce the problem in a simple Citect project such as the test project provided with this driver and provide a backup of this project IEC870t_Driver_Manual doc Last Revised 16 April 2002 Page 30 of 38 Mi I ONO L IEC870 5 101 Driver for Citect User
28. ital Inputs used for Single Point Information and Double Point Information Current State D lt ioa gt D lt ioa1 gt lt ioa2 gt lt ioa3 gt Quality Descriptor Current QD lt ioa gt QD lt ioa1 gt lt ioa2 gt lt ioa3 gt State Value triggered SOE Value SD lt ioa gt SD lt ioa1 gt lt ioa2 gt lt ioa3 gt Value triggered SOE ST lt ioa gt ST lt ioa1 gt lt ioa2 gt lt ioa3 gt Timestamp Time triggered SOE Value TTSD lt ioa gt TTSD lt ioa1 gt lt ioa2 gt lt ioa3 gt Time triggered SOE Timestamp TTST lt ioa gt TTST lt ioa1 gt lt ioa2 gt lt ioa3 gt Quality Descriptor SOE Value SQD lt ioa gt SQD lt ioa1 gt lt ioa2 gt lt ioa3 gt Double Point Intermediate and Indeterminate states will be flagged in the Quality Descriptor 7 1 2 Integer Inputs Step position information and Measured Values Note that both forms of Measured Value scaled and normalised are returned as signed two s complement integers Normalised values according to the IEC standards range over raw values from 32768 to 32767 Current Value l lt ioa gt Igioa1 gt lt ioa2 gt lt ioa3 gt Quality Descriptor Current QD lt ioa gt QD lt ioa1 gt lt ioa2 gt lt ioa3 gt State Value triggered SOE Value Sl lt ioa gt Sl lt ioa1 gt lt ioa2 gt lt i0a3 gt Value triggered SOE ST lt ioa gt ST lt ioa1 gt lt ioa2 gt lt ioa3 gt Timestamp Time triggered SOE Value TT
29. itect 0 Disables 1 Enables AccumFreeze Invalidate IEC870t Driver Manual doc Last Revised 16 April 2002 Page 12 of 38 Microsol Iesst SC 28 IEC870 5 101 Driver for Citect User Manual Advanced Technology Systems Revision 107 SecurityCode This driver is copy protected using the Citect Security Dongle Microsol will provide a code string for the parameter that matches your Citect Hardware Key If no code or an incorrect code is specified the driver will enter demo mode and run correctly returning data for 1 hour Please see the getting start section of how to obtain this code string Kernel PortName Valid port The port name from the Citect Ports Debugstr name form of a serial port is specified here to log debug information about driver activity The information is logged to the Citect Kernel and the winnt syslog dat file When the first IEC870T channel is initialised the configuration files are read and processed At this point kernel debug messages will be generated for any errors in the file So in order to see these it is advisable to set the debug parameter in the citect ini file to show all debug messages for the first channel at least on initial runs until the configuration file has been validated E g IEC870T debugstr ChannelName ALL Where ChannelName is the port name from the Ci
30. nfirm all the configuration parameter are correct and both the Citect values and the RTU value match See the Troubleshooting section for more information IEC870t_Driver_Manual doc Last Revised 16 April 2002 Page 29 of 38 Mi I 1 ONO L IEC870 5 101 Driver for Citect User Manual Advanced Technology Systems Revision 107 11 Troubleshooting IEC60870 5 101 is a complex protocol with many interoperability issues Due to the number of message types defined in the protocol only those that are likely to be used in practice have been implemented see the Interoperability List for details If you find that a message type you need is not yet supported in the driver please contact your supplier and it will be added as soon as possible Interoperability problems like the above or configuration errors may cause communication errors to appear The best way to diagnose these is to look at the low level data packets passing back and forth between devices and the Citect I O Server PC A data analyser is ideal for this but Citect s low level COMx logging can also be used 11 1 COMx Logging The Citect COMx serial driver is used by IEC870t driver to communication via the serial ports of the PG This driver includes some basic debug facilities that enable the user to see the actual data transmitted and received from the communication port See Citect knowledge base article Q2404 for more
31. nly and are not used by default 2 2 Determining Driver Copy Protection License Key The IEC870T driver has built in copy protection to prevent unauthorised use The security provisions allow the driver to operate for 1 hour in demo mode after this time it will stop returning data The copy protection for the IEC driver is keyed to your Citect license hardware key dongle To obtain the ID for IEC870T driver will run by performing the following steps 1 Ensure that your Citect license hardware key dongle is correctly attached 2 Start up a command prompt window 3 Run the find id utility that comes with the IEC870T distribution this should be installed in the citect bin directory 4 The find id will return a License Serial Number send this to your IEC870T distributor If you get an error message then e Check that the Citect license hardware key is correctly attached IEC870t Driver Manual doc Last Revised 16 April 2002 Page 6 of 38 Mi I 1 ONO L IEC870 5 101 Driver for Citect User Manual Advanced Technology Systems Revision 107 e Upgrade the Sentinel license hardware key drivers to rev 5 36 or greater A suitable release of the Sentinel driver rev 5 38 is included with the IEC870T distribution 5 Microsol will issue a security code corresponding to your License Serial Number 6 Place this Security Code in your Citect ini file as follows Fo
32. nnnnnnnnnnnnnnnnen 16 4 1 Unit Configuration File eco dt 16 4 2 IOA Configuration File IECIOA DBF AA 17 4 2 1 Configuration of Double Digital Outpouts 18 Iris Urteel CN 19 5 1 Quality DOSCrIPLONS e S a a raa a aa r aa SE aAA AA aa aaan 19 Processing Time Stamped Data rrnnnnrnnnvvnnnnvnnnnnvnnnnnnnnnvnnnnnvnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnvnnnnnnnnnnnnnnnnnnn 21 G nn lu EE 21 6 2 Time Stamped Data Queues sessseeieeeineseresersstnssttssttssttesttnstnnstnntrnnstensnnnstnnstnnntnnntnnntnnnnt 21 6 3 SOE Hold Mechanism irica ctert a aa eal eA aes tenet ec 22 Accessing Device Data ernnnnnnnvnnnnnnnvnnnnnnnvnnnnnnnvnnnnnnnvnnnnnnnvnnnnnnnvennnnnnvnnnnnnnnennnnnnnnnnnnnneennnnnneenennen 23 7 1 Register el 23 7 1 1 Digital Inputs used for Single Point Information and Double Point Information 23 7 1 2 Integer Inputs Step position information and Measured Values asseeseeseeeseeeen 23 7 1 3 Long Integer Inputs used for Integrated total Counters rrrarnrnnanvrnrnrrnnnnrrnnnnnnnennn 24 7 1 4 Float Inputs used for Short Floating Measurand Values 24 7 1 5 Digital Outputs used for Single Command Single Digital Output Double Command Double Digital Output and Regulating Step Commande 24 7 1 6 Integer Outputs used for Set Point Commande 24 7 1 7 Force General Interrogation eenn netn nesr netrnetrnsttnsnnstnsstnssensstnssrnsstensnene 25 7 1 8 Force Counter Interrogation 25 7 1 9 F
33. ntioned in the previous section for a single IOA or point IOAs points missing from the file or every IOA if the file is missing will default use the default values The fields for each row listed in the table below CHANNEL Serial channel Citect Port Name the device is connected on This field may be blank or completely absent from the file in which case the first device that Citect starts with this rows common address will use this row s configuration Unless two units share the same common address in that situation you must specify the channel COMMADDR IEC Device Common address Common address of ASDU IOA Information Object Address for this point TYPE For Output points only leave blank for other point types Single or Double Control Output or Regulating Step Command e SDO Single Digital Output default e DDO Double Digital Output e RSO Regulating Step Output Set Point Command e NORM Sentas a Normalised Value e SCALE Sentas a Scaled Value The default setpoint is specified by the driver configuration parameter DefaultSetPtType IEC870t_Driver_Manual doc Last Revised 16 April 2002 Page 17 of 38 Microsol KOL IEC870 5 101 Driver for Citect User Manual QUALIF Advanced Technology Systems Revision 107 Control Qualifier for Output points only leave blank for other point types Single or Double Control Output or
34. orce Clock Synchronisation cccccccceeeeceeseeeeeeeeeeaeeeeaaeseeeeeseaeeeeaaeeseaeeseeeeeseaeeeseeeeeeees 25 FAAOs Gounter EE 25 AAI Counter Deet gaere dee ee Niet Grysen ege ial Bays gen eege Mae eves 25 7 1 12 Counter Freeze and Heset nernet nsrnstnstrnstnstnntnntnnstnsstnsstensrennrennnene 25 Configuring the Citect Alarm Server nmsvrnnnvnnnnnvnnnnnnnnnvnnnnnvnnnnnnnnnnnnnnnvnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnner 26 8 1 1 NEE 26 81 2 Aarm E Un 26 8 2 Driver Statistics Las fr keep ud ke ae ett Ge ie le eee akkar 26 Protocol ISSUCS sssnvnnnnnnnvnnnnnnnvnnnnnnnvennnnnneennnnnnnennnnnnnnnnnnnnnnnnnnnnnennnnnnnennnnnnnennnnnnnnnnnnnnnnnnnnnnnnnnnnnnnene 28 9 1 Handling of Non Timestamped Input Data 28 9 2 Events During General Interrogations ccccececeeeeceeeeeeeeeeaeeeeeeeceaeeesaaeseeaeeseeeeeeeaeeesaeeeeneeeea 28 IEC870t Driver Manual doc Last Revised 16 April 2002 Page 3 of 38 Microsol 1 ONO L IEC870 5 101 Driver for Citect User Manual Revision 107 Advanced Technology Systems 10 Testing The RTE 29 11 Troubleshooting s idiuetkt testede aienea AAEE sgt ceaheascdccela seccueetdseseendasacocdetsacessacdactiess 30 TAD GOMX LOGGING are ee treer evne 30 11 2 Gathering Information for a Support Heouest 30 Appendix A IEC 870 5 101 Interoperability LiSt rrrnrnnnnnrnnnnvrnnnvrnnnnvnnnnnnnnnnvnnnnvnnnnnnnnnnnnnnnnnnr 32 IEC870t_Driver_Manual doc Las
35. ow many servers are defined on the Citect network that read SOEs In other words how many different Citect processes will read each SOE See section 3 3 SOEQueue 500 0 32767 Size of SOE queue per device SOERmUnusedMs 5000 0 32767 SOE Remove Unused Hold time to keep unread SOEs on the queue before we delete them milliseconds See section SOE Hold Mechanism SOEHoldMs 2000 0 32767 Time to keep SOE entries in the queue that have been read at least once but not by the configured number of alarm servers See section SOE Hold Mechanism SOERmCheckMs 1000 0 32767 SOE Remove Check How often to run through SOE queues checking for timed out SOEs to be removed milliseconds See section SOE Hold Mechanism ReceiveQueueSize 250 0 32767 Size of the Interrupt data Receive Queue in number of messages per channel Allow AT LEAST one entry for all the messages in the largest Gl initiation plus 20 StoreDigitallnQual 0 Oor 1 If set it places the state of the point either single or double digital points is stored inside the quality descriptor This allows a single tag to be used for both value and quality information thus reducing the total number of tags required Oor 1 Whether to mark accumulators affected by a freeze as not valid when the freeze is done This will have the effect of forcing them to be re read from the device the next time a read request for them is received from C
36. r example IEC870T Securit yCode DEADDODO 2 3 Adding a New Protocol Entry A new entry must be added to Citect s protocols database This is stored in the database file citect bin protdir dbf This file is in the standard dBASE III format used by Citect It should be edited using a database editor capable of editing these files e g access dBASE or FoxPro Note There are some issues when using Microsoft Excel as a database editor see the Citect documentation for more information To add this entry to the database file to register the protocol A new row should be added as follows IEC870T IEC870T 2048 2048 0x07f Note If you reinstall Citect the PROTDIR DBF file will be overwritten and you will have to re add this entry 2 4 Citect I O Forms Configuration See the Citect documentation for more information about configuring IO Forms 1 Make an entry in the Citect Ports form for each serial channel as follows e Port Number COM port number e Baud Rate Baud rate of connected devices e g 9600 e Data Bits 8 e Stop Bits 1 e Parity EVEN_P 2 Make an entry in the Citect IO Devices form for each device as follows e Address Device address of the connected device e g 1 e Protocol IEC870T e Port Name one of the ports defined above 2 5 Example IEC870T Citect Project The IEC870T driver disk also contains a backup of an example
37. rability problems This section documents the way that some of these ambiguities have been interpreted and implemented for IEC870T 9 1 Handling of Non Timestamped Input Data A given IOA can be send by an RTU in several different message types some containing timestamps and some not Any timestamped data will be processed by the driver as a new event and added to the SOE queues Non timestamped data is processed by the driver for each IOA as follows e If no previous data for this IOA has been received then the new data is stored e if the new value state or quality descriptor is different than the previous stored value then the new data is stored e If the value state and quality descriptor are the same as the previously stored value new data is discarded If the new data is stored then the timestamp is set to the time on the PC when the message arrived and the timestamp set on PC flag in the quality descriptor is set 9 2 Events During General Interrogations The can be an issue if while retrieving data from the RTU for a General Interrogation GI a state change spontaneous event occurs Depending on the RTU s implementation this new state change event may remain queued on the RTU until the GI is complete or may be sent immediately in the middle of the GI The driver assumes that the RTU will correctly use Cause of Transmission fields to identify data being sent in response to a GI as opposed to spontaneous transmission If
38. specific parameter lt 1 gt Single point information M SP NA 1 lt 2 gt Single point information with time tag M SP TA 1 lt 3 gt Double point information M DP NA 1 lt 4 gt Double point information with time tag M DP TA 1 lt 5 gt Step position information M ST NA 1 lt 6 gt Step position information with time tag M ST TA 1 lt 7 gt Bitstring of 32 bit M BO NA 1 lt 8 gt Bitstring of 32 bit with time tag M BO TA 1 lt 9 gt Measured value normalized value M ME NA 1 lt 10 gt Measured value normalized value with time tag M ME TA 1 lt 11 gt Measured value scaled value M ME NB 1 lt 12 gt Measured value scaled value with time tag MME TB 1 lt 13 gt Measured value short floating point value M ME NC 1 lt 14 gt Measured value short floating point value with time tag M ME TC 1 lt 15 gt Integrated totals MIT NA 1 lt 16 gt Integrated totals with time tag MIT TA 1 lt 17 gt Event of protection equipment with time tag M EP TA 1 lt 18 gt Packed start event of protection equipment with time tag M EP TB 1 lt 19 gt Packed output circuit information of protection equipment with time tag M EP TC 1 lt 20 gt Packed single point information with status change detection M PS NA 1 NN Feo nn HERE lt 21 gt Measured value normalised value without quality descriptor M ME ND 1 IEC870t Driver Manual doc Last Revised 16 April 2002 Page 34 of 38 Mi I 1 ONO L IEC87
39. t Revised 16 April 2002 Page 4 of 38 Mi I 1 ONO L IEC870 5 101 Driver for Citect User Manual Advanced Technology Systems Revision 107 1 Introduction The IEC870t Citect driver is a 32 bit driver that provides communication services for devices that use the IEC870 5 101 Communication Protocol Many protocol configuration parameters are supported and all of the commonly used functions are implemented See the IEC Interoperability List in appendix A for details The driver supports multiple serial channels and multiple devices on each serial channel In addition support is provided for installations where the IEC Common address is different from the Link address Citect s underlying COMX driver is used for serial communication so socket communication over TCP IP is also supported However this communication mode is not as per the IEC870 5 104 standard that differs from T101 in catering for WAN latency 1 1 Driver Operation The driver employs front end back end architecture which means that a memory image of a current state device s I O data is maintained in the driver Updating of this memory image is not driven by Citect s Read operations to the driver When Citect performs a read operation the value Citect receives comes from the IEC driver s memory image In addition to the current value of the points the IEC driver also maintains information about t
40. t individually in the IOA configuration File The allowable values are 0 Digital Controls default to No additional definition 1 Digital Controls default to Short Duration Pulse 2 Digital Controls default to Long Duration Pulse 3 Digital Controls default to Persistent Output UseAddrConfigFile Oor 1 If this value is 0 then all Link and Common addresses match each other and are specified in the Citect I O Device Address fields If 1 then Link and Common addresses are specified in a configuration file and may be different Citect UO Device Address fields are then indexes into rows in this configuration file AddrConfigFileName C citect bi n lECunits dbf Valid path Specifies the file name and path of the configuration file containing device Link and Common addresses UselOAConfigFile Oor 1 If O then no individual IOA configuration is to be used This means that Double Digital Outputs and Regulating Step commands will not be available It also means that all Single Digital Outputs and Set Points will have the default Qualifier and select execute flag IOAConfigFileName C citect bi n IECioa d bf Valid Path Specifies the file name and path of the configuration file containing individual IOA parameters IEC870t Driver Manual doc Last Revised 16 April 2002 Page 9 of 38 Microsol Iesst SC 28 IEC870 5 101 Driver for
41. tCount 3 0 32767 Number of timeouts to occur before a device is marked as Offline RxInactivityTimeout 0 0 32767 How long to allow a link to be idle before taking the device offline seconds Default is no limit The limit will only apply if no polling is done on the link i e the driver is in balanced mode and TxTestLink parameter is set to 0 Typically this parameter would be set to about 3 times the device s Test Link polling period or to 0 to disable the timeout if no regular polling occurs from the device DefaultSOEMode 0 Oor 1 Each Input IOA can be configured to support SOEs or not in the driver This sets the default for all IOAs that do not override this SOEs will default to enabled if this parameter is 1 disabled if O If SOEs are to be used try to ensure that only those IOAs for which Citect will use SOE data have SOEs enabled IEC870t_Driver_Manual doc Last Revised 16 April 2002 Page 11 of 38 Microsol Iesst SC 28 IEC870 5 101 Driver for Citect User Manual Advanced Technology Systems Revision 107 DefaultAnalogSOEMode Each Input Analogue IOA can be configured to support SOEs or not in the driver This sets the default for all Analogue Input IOAs that do not override this SOEs will default to enabled if this parameter is 1 disabled if O It is recommended that SOE not be used for analogue points MaxSOE Server 1 1 to 32767 H
42. tect Ports form of the first serial port that will be used with the IEC870T101 driver IEC870t_Driver_Manual doc Last Revised 16 April 2002 Page 13 of 38 Ro el 3 Advanced Technology Systems 3 3 Channel Parameters Microsol IEC870 5 101 Driver for Citect User Manual Revision 107 The following port specific parameters may be added to the IEC870t section lt PortName gt I1OAOctets 123 Size of Information Object Addresses in octets lt PortName gt LinkAddrOctets 12 Size of Link addresses in octets lt PortName gt CommonAddrOctets 012 Size of Common addresses in octets 0 is only valid for balanced mode lt PortName gt BalancedMode 01 Selects balanced mode 1 Or unbalanced mode 0 lt PortName gt COTLength Length of the cause of transmission in octets lt PortName gt Station AorB This applies only in Balanced mode and allows the Citect end of a balanced link to be either Station A or Station B See the IEC870 5 101 standard for more information lt PortName gt InterCharTimeoutMs 100 0 32767 Allowable gap between characters in a message from a device The intercharacter timeout is an extra check to ensure the end of a message is recognised as such should things get out of step The ideal theoretical value is dependent on baud rate as this det
43. the driver receives non Gl data for an IOA while a GI is underway then this data will be stored and the IOA will be marked to prevent any Gi data overwriting it for the duration of the current Gl IEC870t_Driver_Manual doc Last Revised 16 April 2002 Page 28 of 38 Microsol 1 ONO L IEC870 5 101 Driver for Citect User Manual Hdvanced Technology Systems Revision 107 10 Testing The Driver Once the driver has been configured correctly connect the IEC RTU to the configured communication port on Citect PC Check that the following protocol parameters match between the device and the Citect driver See section 1 above for details on these parameters and their default values If their default values don t suit then set them correctly IEC870T e lt PortName gt lOAOctets lt PortName gt LinkAddrOctets lt PortName gt CommonAddrOctets lt PortName gt BalancedMode lt PortName gt COTLength lt PortName gt Station Note only needed for Balanced Mode Enable basic debug output in the Citect Kernel window with entries in the winnt citect ini file as follows e DEBUG Kernel 1 e IEC870T debugstr lt PortName gt lt PortName gt Log 1 Start the Citect Runtime system by clicking on the RUN icon on the Citect Explorer speed bar If everything in configured correctly and the cabling is correct the device should now come online If the system is still not communicating co
44. ut are returned in the driver s Citect Quality descriptor pseudo registers Consequently all input data points will have Citect Quality Descriptor pseudo registers even those which do not have a protocol Quality Descriptor implemented Note that an input point could be read from a device as unpacked protocol data packets with Quality Descriptors or in packed form without Hence a bit is allocated in the Citect Quality Descriptor word to flag that the current data is without a protocol quality descriptor and that some other bits in the Citect Quality Descriptor are therefore old The old bits would be those from the Protocol Quality Descriptor Invalid Not Topical Substituted Blocked Overflow IEC870t_Driver_Manual doc Last Revised 16 April 2002 Page 20 of 38 Mi I 1 ONO L IEC870 5 101 Driver for Citect User Manual Advanced Technology Systems Revision 107 6 Processing Time Stamped Data Note The term Sequence of Events SOE processing is used to describe time tagged data events 6 1 Time Stamps Timestamps in this protocol are received from devices as either e Three byte integers containing the number of milliseconds since the last o clock i e the minutes seconds and milliseconds components of the time of day or e Seven byte integers containing the above plus information up to and including years a recent extension to the standard
45. vision 107 2 Getting Started The driver contains many configuration options Fortunately not all of these options need to be configured for basic communication functionality Ensure that configuration details for the RTU s are available how both communications and protocol are configured Due to the nature of the IEC protocol differences in the configuration details may stop the RTU and Citect from communicating correctly NOTE Familiarity with Citect is assumed Please see your Citect documentation for more information about how to configure a Citect system NOTE If you are using Citect Version 5 4 the you MUST install Service Pack C for the driver to work correctly in redundant configurations This document also assumes the reader is familiar with the IEC870 1 105 protocol The list below provides a basic set of instructions for connecting an RTU to Citect via the IEC870T driver 2 1 Driver Installation Run the installation program setup exe on the distribution disk This will install the driver executables and documentation onto a directory on your hard disk The following files will be copied to a 32 bit Citect installation s citect bin lec870t dIl Driver Dynamic Link Library Find_id exe Utility for determining Citect ID Hardware Code lec870t dbf Driver configuration file lecioa dbf and lecUnit dbf note that these are sample configuration files o
46. wing conditions is met A All SOE server tasks have read the event i e the number of SOE servers as configured by the MaxSOEServer Parameter B At least ONE SOE server task has read the event and hold time has elapsed i e the SOEHoldMs time has elapsed C The SOERmUnusedMs time has elapsed The processing that clears removes the data from the SOE queue if performed periodically the period is determined by the SOERmCheckMs parameter IEC870t_Driver_Manual doc Last Revised 16 April 2002 Page 22 of 38 Microsol 1 ONO L IEC870 5 101 Driver for Citect User Manual Hdvanced Technology Systems Revision 107 7 Accessing Device Data Once devices have been configured into Citect various register addresses are available for accessing that data 7 1 Register Addresses Citect Variable Tags are mapped to device I O points through register addresses that are be configured with the following syntax Note that two forms of IOA are provided Unstructured lt ioa gt represents a decimal number with a range dependent on the number of configured IOA octets i e it could be 0 255 0 65535 or 0 16777215 Structured lt ioa1 gt lt ioa2 gt and lt ioa3 gt represent decimal numbers in the range 0 255 Note Output points cannot be read from the Driver by Citect this reflects the IEC standard as the protocol does not cater for reading of output points 7 1 1 Dig
Download Pdf Manuals
Related Search