Citect for Windows Driver Specification Extract FIPNT Driver

Transcription

1 Citect for Windows Driver Specification Extract FIPNT Driver Author Date Comment Matthew Costin 24/4/98 Initial draft taken from FIPXWAYI Matthew Costin 14/7/98 Supported data types modified

2 Contents 1. TARGET DEVICE(S) AND PROTOCOL Introduction Device Manufacturer Device Definition Communications Method Communications/Hardware Configuration Wiring Diagrams I/O Device Settings Software Setup Special Requirements Maximum Request Length 7 2. USER INTERFACE Introduction Driver Name Boards Form Board Type Address All Other fields Ports Form Baud Rate Data Bits Stop Bits Parity Special Opt IO Devices Form Protocol Address Pull-down lists Help IO Device Variable Types Formats and types UNITE.DBF Entries PROTDIR.DBF Parameters and INI options Standard Parameters 10 FIPNT.DOC

3 2.9.2 Driver Specific Parameters Remapping Driver Specific Errors Driver Error Help Debug Messages Common Debug Message sequences Stats Special Counters Hints and Tips REFERENCES References 15 FIPNT.DOC

4 1. Target Device(s) and Protocol 1.1 Introduction The FIPNT driver allows Citect to communicate with the TSX family of IO devices via the FIPWAY network. A TSX FPC10 board module must be used to allow the PC to talk on FIPWAY. The driver is 32-bit, multi-threaded, and is designed to run under Windows NT. Hence it will not run under Windows 95. It has been tested with Citect 5.01 under Windows NT v Device Manufacturer Schneider Automation provides cable, connectors, cards, and the TSX IO devices that provide UNI- TE services to the FIPWAY network. Schneider Automation also provides the software protection key for this driver. For details on the software protection refer to Section 3.6 Special Requirements. 1.3 Device Definition The target devices of this driver are the TSX family of IO devices. These include the TSX 37 Micro PLC, and the TSX 57 Premium, as well as the Series 7 PLC s. Remote IO devices can communicate on FIPIO field-bus, and be able to be addressed using XWAY. The older TSX Series 7 PLC s are not supported by this driver. XWAY is the addressing system that allows a terminal connected at any point of an installation to access any device on the network as if it were directly connected to it. The XWAY system complies with the ISO/OSI standardised model. The XWAY communication architecture includes a set of industrial local network protocols, to enable the setting up of structures composed of one or mixed protocols on distributed automated systems. These protocols include FIPWAY, UNI-TELWAY, ETHWAY, and FIPIO field-bus. When XWAY is used, the application interface remains identical across all of these protocols. Any device that can be addressed using XWAY, should be able to communicate with this driver. These devices include TSX PLC s, (TSX field devices over FIPIO see NOTE below), TSX programming terminals as well as other PC s. NOTE: FIPIO will be supported in later revisions of the driver 1.4 Communications Method The FIPWAY network protocol communicates on a 1Mb/s shielded twisted pair network. A FIPWAY network consists of one or more segments connected together by repeaters. The TSX FPC 10 module connects an FTX 507 or CCX 7 type terminal or IBM compatible PC, to a FIPWAY network (or FIPIO field-bus). 1.5 Communications/Hardware Configuration A FIPWAY network can be installed by using TSX FP CAxxx family trunk cables and TSX FP ACC4 taps. The stations have TSX FPP 20 type lll PCMCIA cards installed in them. A TSX FP CE 030 cord is connected to each PCMCIA card. The 9-point male connector of the TSX FP CE 030 cord plugs into the 9-point female connector of each tap junction box. The network must be fitted at both ends with a TSX FP ACC7 line terminator. Below is a diagram of the segment used for testing. Each TSX IO device was a TSX 37 Micro. FIPNT.DOC

5 1.5.1 Wiring Diagrams The TSX FP ACC4 taps are connected between the FIPWAY trunk cable. The wiring is shown in the following extracts, from the Cell Network FIPWAY Communication User s Guide. FIPNT.DOC

6 1.5.2 I/O Device Settings The TSX FPP 20 PCMCIA card has two pairs of dials for setting the XWAY address of the device. The pair marked NET, sets the network number. Each device on the same FIPWAY network must have the same network number. The pair marked STA, sets the station number. Each device on the same FIPWAY network must have a unique station number. The network and station numbers are represented using double digits. One dial in each pair is marked H for high digit, the other is marked L for low digit. No FIPWAY specific PLC code is required for FIPWAY communications to take place. The communications module in the Micro handles all communications, independently from the application program written by the user. The communications module in each PLC must be configured to communicate using FIPWAY. This configuration is performed using the PL7 Micro or PL7 Junior PLC programming/configuration applications. Launch the programming/configuration application and open the STX file for the corresponding PLC. Go to the Application menu and select Configuration. A dialog box with a diagram of the PLC will appear. Double click the communication module (marked Comm), and the configuration dialog box will appear. Ensure that the top left drop down list box shows Configuration. Select the Channel containing the FIPWAY comms module. In the drop down list box along side, select TSX FPP 20 FIPWAY PCMCIA card. Then in the FIPWAY specific information below, select the specific FIPWAY network settings. Up-load the configuration to the PLC, and repeat for all the PLC s. In order to place a PC on the FIPWAY network, the TSX FPC 10 board module must be installed. The board must be configured with DMA and IRQ channels, and base IO address, prior to installation. An available DMA channel number (5, 6, or 7). The selected DMA channel must be set on the module by the pair of jumpers DMA_RQ and DMA_ACK (SW1). The two jumpers must be set to the same value. An available IRQ channel number (3, 5, 10, 11 or 15). The selected IRQ interrupt channel must be set on the module using jumper SW2. A base address so that the addresses occupied by the module can be defined. The board occupies 16 consecutive addresses starting with the base address, in the IO space of the PC. The address must be between 100H and 3F0H. eg. 100H, 110H, 120H, etc. The selected base address of the card must be coded using dip-switches SW3 on the module. The module is then inserted in an empty slot with a 16-bit connector. The module is connected to the network using cable TSX FP CE Software Setup The software driver for the TSX FPC 10 board module needs to be installed. This software comes on an installation disk that accompanies the software protection key. The installation of the software involves the following steps, installing the FPCUNI-TE/NT library, installing the Sentinel system, and finally, installing and configuring the FIPWAY driver. After creating a backup of the installation disk, start an NT session with administrator rights. Insert the FPCUNI-TE/NT disk into drive A. Run A:\SETUP.EXE and follow the procedure. When the Sentinel driver set-up program dialog is displayed, select Function then Installation Sentinel driver. Start the Sentinel system installation then restart the machine. Next, the FIPWAY driver itself must be installed. Insert the FPCUNI-TE/NT disk into drive A. Run A:\SETUP.EXE, then follow the procedure. DFPWAY.EXE is the board driver and DFPWAY.001 is the profile that the board driver will run. The profile DFPWAY.001 holds the driver configuration settings. The installation should set up a program group named TELEMECHANIQUE FIPWAY. Into this group you will find a configuration tool used to configure the profile file, DFPWAY.001. The file name of the configuration tool is CNFFIP.EXE. Launch the configuration tool, CNFFIP.EXE. Select FIPWAY mode and enter the Network and Station for the port. Select Driver Instance FIP01. Under the File menu, go to Advanced Configuration. Verify that the correct IO Address, Interrupt, and DMA channel are selected. Leave the dialog box. Save the profile as DFPWAY.001 in the ASA driver directory, and exit. The installation of the TSX FPC 10 board module is now complete. Restart the computer, in order for the changes to take effect. FIPNT.DOC

7 1.6 Special Requirements A software protection key is required by the user. These are supplied by Schneider Automation. This key will enable the driver to communicate. Accompanying the key will be an installation disk that is used to install the board driver software. The part number from Schneider Automation is YCC FPW PC NT V1 E. 1.7 Maximum Request Length The maximum request length is 120 bytes. This is the maximum amount of data that can be read in one read request. FIPNT.DOC

8 2. User Interface 2.1 Introduction This section defines how the user will see the driver. This relates directly to how the Citect forms need to be filled out and any special INI options. For the kernel, the debug trace messages and the Stats.Special counters are documented. 2.2 Driver Name The name of the driver is FIPNT. 2.3 Boards Form The driver does not configure or validate any board parameters at run time. All of the parameters of the FIPWAY board are set by the FIP FPC10 Configuration application, prior to the running of Citect. Refer to section 3.5 Communications/Hardware Configuration, for more details Board Type Citect tries to link with the DLL in the BIN directory that has the name matching the board type. The DLL for the FIPNT driver is FIPNT.DLL. Therefore it is necessary for the Board Type to be FIPNT Address The FIPNT driver does not configure the address of the board at run-time. The Citect compiler will generate an error if the Address is left blank. Therefore it is necessary to leave a dummy value, which the driver will ignore. A dummy address of zero is suggested All Other fields All fields of the board form, except for Board Type and Address, may be left blank. 2.4 Ports Form The driver does not configure or validate any port parameters at run time. All of the parameters of the FIPWAY port are set by the FIP FPC10 Configuration application, prior to the running of Citect. Refer to section 3.5 Communications/Hardware Configuration, for more details Baud Rate The Baud Rate field is not accessed by the driver, and should be left blank Data Bits The Data Bits field is not accessed by the driver, and should be left blank Stop Bits The Stop Bits field is not accessed by the driver, and should be left blank Parity The Parity field is not accessed by the driver, and should be left blank. FIPNT.DOC

9 2.4.5 Special Opt No Special Options apply. 2.5 IO Devices Form Protocol The name of the protocol is FIPNT Address The XWAY address of a communication entity consists of the network number, the station number and the gate number. Each number is separated by a dot, with no spaces. eg The network number uniquely identifies the network of the communication entity. It must be between 0 and 127. The station number uniquely identifies the station of the communication entity. It must be between 0 and 63. The gate number is used to determine the communication entity within the selected station. During development and testing, three TSX Micro PLC s were on a network along with the Citect computer. The network number was set to 3. The station number of the PLC s were 3, 4 and 5. The station number of FIPNT driver in Citect was 8. Citect was polling the system ( UNI-TE server ) of each PLC. The gate number for the system of any station is zero. The addresses of the test devices were: TSX Micro A TSX Micro B TSX Micro C Pull-down lists Help The following entries should be included in the Citect Help.DBF spec file. TYPE DATA FILTER BOARDTYPE PROTOCOL FIPNT FIPNT 2.7 IO Device Variable Types Formats and types IO Device Type Citect data format Citect types data Description/Special Valid Ranges Usage/Limitations/ Internal bit Mn DIGITAL Single bit values, accessible by the user program. System Bit Sn DIGITAL Single bit values, pertaining to attributes of the system. Internal word MWn INT 16 bit signed integer values, accessible by the user program. Constant Word KWn INT Read Only, 16 bit signed integer values. Able to be modified by PL7 software. System Word SWn INT 16 bit signed integer values, pertaining to attributes of the system. FIPNT.DOC

10 Where n is the address of the data object. The ranges of the valid addresses for the above data areas are configured using PL7 programming/configuration software UNITE.DBF Entries The following are the actual entries in the UNITE.DBF file. The one file, UNITE.DBF, is used for all the Telemecanique data objects. TEMPLATE UNIT_TYPE RAW_TYPE BIT_WIDTH LOW HIGH COMMENT M%U Internal Bit S%U System Bit MW%U Internal Word KW%U Constant Word SW%U System Word 2.8 PROTDIR.DBF TAG FILE BIT_BLOCK MAX_LENGTH OPTIONS FIPNT UNITE x4B 2.9 Parameters and INI options Standard Parameters Block = 120 Delay = 0 MaxPending = 1 Polltime = 1 Timeout = 1000 Retry = 1 WatchTime = Driver Specific Parameters There are no driver specific parameters Remapping No remapping is implemented Driver Specific Errors Driver Error Code (Hexadecimal) Mapped to (Generic Error label) 35 GENERIC_INVALID_ COMMAND 36 GENERIC_ADDRESS RANGE_ 37 GENERIC_CHANNEL_ NOT_INIT Meaning of Error Code Flag not valid Out of bound value Driver not open 38 GENERIC_NO_MEMORY No more memory available FIPNT.DOC

11 39 GENERIC_ADDRESS_ RANGE_ 3A 3B 3C 3D GENERIC_ADDRESS_ RANGE_ GENERIC_CHANNEL_ NOT_INIT GENERIC_SOFTWARE_ GENERIC_SOFTWARE_ Origin address not valid Destination address not valid Communication channel not opened Building error Mode parameter error 3E GENERIC_UNIT_OFFLINE Negative UNI-TE response 3F GENERIC_UNIT_OFFLINE Mirror request error 40 GENERIC_UNIT_OFFLINE Time-out error 41 GENERIC_UNIT_OFFLINE Bad address 42 GENERIC_CHANNEL_ NOT_INIT 43 GENERIC_CHANNEL_ NOT_INIT 44 GENERIC_SOFTWARE_ All communications channels opened Communication channel not opened Driver already opened 45 GENERIC_NO_BUFFERS Internal resources not allocated 46 GENERIC_BAD _PARAMETER 47 GENERIC_HARDWARE_ 48 GENERIC_NO_MORE_ CHANNELS 97 GENERIC_CHANNEL_ OFFLINE 98 GENERIC_CHANNEL_ OFFLINE 99 GENERIC_CHANNEL_ OFFLINE 9A 9B 9C 9D 9E GENERIC_CHANNEL_ OFFLINE GENERIC_NO_MORE_ CHANNELS GENERIC_CHANNEL_ OFFLINE GENERIC_TOO_MANY_ COMMANDS GENERIC_HARDWARE_ Parameter not valid No protection key Unsolicited data channel already opened Network or driver not available No connection for handle Communication channel not opened Channel number out of range No channel available Communication channel already reserved Message in channel queue Protocol and driver incompatibility FIPNT.DOC

12 9F GENERIC_NO_BUFFERS Buffer size not valid A0 GENERIC_UNIT_OFFLINE Connection not possible A1 GENERIC_NO_BUFFERS Driver buffer unavailable A2 GENERIC_SOFTWARE_ A3 GENERIC_UNIT_OFFLINE Time-out A4 A5 A6 A7 A8 A9 GENERIC_SOFTWARE_ GENERIC_SOFTWARE_ GENERIC_SOFTWARE_ GENERIC_SOFTWARE_ GENERIC_BAD _PARAMETER GENERIC_CHANNEL_ OFFLINE Asynchronous mode forbidden IOCB not allocated in asynchronous mode Flag address not valid Flag mode not valid Temporary status - Connection not yet established IOCB parameter error Negative acknowledge from local device AA GENERIC_UNIT_OFFLINE Negative acknowledge from remote device AB GENERIC_HARDWARE_ Network and driver incompatible 2.12 Driver Error Help The following entries should be included in the Citect PROTERR.DBF spec file. PROTOCOL MASK MESSAGE REFERENCE 9 FIPXWAYI Alias 9 FIPXWAYP Alias 9 FIPNT Alias 9 UNINT Alias 9 UNIXWAY Alias 9FIPNT 0 35 Flag not valid 9FIPNT 0 36 Out of bound value 9FIPNT 0 37 Driver not open 9FIPNT 0 38 No more memory available 9FIPNT 0 39 Origin address not valid 9FIPNT 0 3A Destination address not valid 9FIPNT 0 3B Communication channel not opened 9FIPNT 0 3C Building error 9FIPNT 0 3D Mode parameter error 9FIPNT 0 3E Negative UNI-TE response 9FIPNT 0 3F Mirror request error 9FIPNT 0 40 Time-out error 9FIPNT 0 41 Bad address 9FIPNT 0 42 All communications channels opened 9FIPNT 0 43 Communication channel not opened 9FIPNT 0 44 Driver already opened FIPNT.DOC

13 9FIPNT 0 45 Internal resources not allocated 9FIPNT 0 46 Parameter not valid 9FIPNT 0 47 No protection key 9FIPNT 0 48 Unsolicited data channel already opened 9FIPNT 0 97 Network or driver not available 9FIPNT 0 98 No connection for handle 9FIPNT 0 99 Communication channel not opened 9FIPNT 0 9A Channel number out of range 9FIPNT 0 9B No channel available 9FIPNT 0 9C Communication channel already reserved 9FIPNT 0 9D Message in channel queue 9FIPNT 0 9E Protocol and driver incompatibility 9FIPNT 0 9F Buffer size not valid 9FIPNT 0 A0 Connection not possible 9FIPNT 0 A1 Driver buffer unavailable 9FIPNT 0 A2 Asynchronous mode forbidden 9FIPNT 0 A3 Time-out 9FIPNT 0 A4 IOCB not allocated in asynchronous mode 9FIPNT 0 A5 Flag address not valid 9FIPNT 0 A6 Flag mode not valid 9FIPNT 0 A7 Temporary status - Connection not yet establish 9FIPNT 0 A8 IOCB parameter error 9FIPNT 0 A9 Negative acknowledge from local device 9FIPNT 0 AA Negative acknowledge from remote device 9FIPNT 0 AB Network and driver incompatible 2.13 Debug Messages Debug messages are logged that detail the UNITE API calls occurring. Following is a list of all the debug messages in the driver. <Time-stamp> InitChannel called <Length 0> <Time-stamp> UNITEOpenConnection called <Length 0> <Time-stamp> UNITECloseConnection called <Length 0> <Time-stamp> UNITEMirror called <Length 0> <Time-stamp> UNITEReadObject called <Length 0> <Time-stamp> UNITEWriteObject called <Length 0> <Time-stamp> UNITEWriteInternalBit called <Length 0> <Time-stamp> UNITEWriteSystemBit called <Length 0> <Time-stamp> UNITEResponse called <Length 0> <Time-stamp> UNITEGetUsExtInfo called <Length 0> <Time-stamp> TimeOut called <Length 0> Common Debug Message sequences Initialising Tue Apr 21 11:56: :04: Citect Startup 5.00 Rev. 00 Tue Apr 21 11:56: :04: InitChannel called Length 0 Tue Apr 21 11:56: :04: UNITEOpenConnection called Length 0 Tue Apr 21 11:56: :04: UNITEMirror called Length 0 Tue Apr 21 11:56: :04: UNITEResponse called Length Reading data Tue Apr 21 11:56: :04: UNITEReadObject called Length 0 Tue Apr 21 11:56: :04: UNITEResponse called Length 0 FIPNT.DOC

14 Writing data Tue Apr 21 11:56: :04: UNITEWriteObject called Length 0 Tue Apr 21 11:56: :04: UNITEResponse called Length Stats Special Counters Number Label Purpose/Meaning of this counter 0 Total Cmds Counter for each Citect command received by the driver 1 Total Req Counter for each UNITE request initiated by the driver 2 LastError Last UNITE error returned Hints and Tips No inconsistencies have been found to date. FIPNT.DOC

15 3. References 3.1 References X-WAY Communication Reference Manual Cell Network FIPWAY Communication User s Guide TSX FPC 10 / FPC 20 FIPIO/FIPWAY Modules PL7 Micro Software Reference Manual - page 1/8 FIPNT.DOC