background image

 

Driver Version: 

1.12 

Document Revision:  4.D 

 

 

 

 

 

 

 

 

 

 

FieldServer  

FS-8704-14 EtherNet/IP 

Driver Manual 

(Supplement to the FieldServer Instruction Manual)

 

 

 

 

 

 

 

 

 

 

 

APPLICABILITY & EFFECTIVITY 

Effective for all systems manufactured after May 2018. 

Summary of Contents for FS-8704-14

Page 1: ...rsion 1 12 Document Revision 4 D FieldServer FS 8704 14 EtherNet IP Driver Manual Supplement to the FieldServer Instruction Manual APPLICABILITY EFFECTIVITY Effective for all systems manufactured after May 2018 ...

Page 2: ...port needs related to the FieldServer product Sierra Monitor Corporation 1991 Tarob Court Milpitas CA 95035 Website www sierramonitor com U S Support Information 1 408 964 4443 1 800 727 4377 Email support sierramonitor com EMEA Support Information 44 2033 1813 41 Email support emea sierramonitor com ...

Page 3: ...ecific Map Descriptor Parameters Data Table Read Write 16 6 3 4 Driver Related Map Descriptor Parameters PCCC 17 6 3 5 Server Specific Map Descriptor Parameters Implicit IO Messages 17 6 3 6 Map Descriptor Example 1 Unconnected Messages 18 6 3 7 Map Descriptor Example 2 Data Table Messages 18 6 3 8 Map Descriptor Example 3 PCCC Messages 18 6 3 9 Map Descriptor Example 4 Implicit IO Messages 18 App...

Page 4: ...38 Appendix C 2 Connection Information Allen Bradley Message Blocks 38 Appendix C 3 FieldServer Not Recognized by RSlinx 38 Appendix C 4 Using EIP Data_Types with RSLogix 38 Appendix D Reference 39 Appendix D 1 Error Messages 39 Appendix D 2 Classes and Attributes Supported 39 Appendix D 3 Error Codes 41 ...

Page 5: ...ployed by all Logix Series PLC s PCCC support is also provided for legacy devices that do not fully support CIP encapsulation EIP PCCC Encapsulation was tested at the Sierra Monitor factory using a PLC5 I785 ENET card The following data types were tested N F S The Driver also supports PCCC communication on SLC and MicroLogix Tested on MicroLogix 1400 Device Fragmented Services 0x52 is supported fo...

Page 6: ...nect an EtherNet IP device to either port N1 or N2 on the FieldServer These ports must just be configured to use EtherNet IP in the configuration file FieldServer FieldServer Part 8915 10 UTP cable Connect to an Ethernet Port on the FieldServer N1 1 9 Switch Remote EtherNet IP Device ...

Page 7: ...ame Provide name for Data Array Up to 15 alphanumeric characters Data_Array_Format Provide data format Each Data Array can only take on one format FLOAT BIT UInt16 SInt16 Byte Data_Array_Length Number of Data Objects Must be larger than the data storage area required by the Map Descriptors for the data being placed in this array 1 10 000 Example Data Arrays Data_Arrays Data_Array_Name Data_Array_F...

Page 8: ...eclared in the Data Arrays section the destination device addresses need to be declared in the Client Side Nodes section and the data required from the servers needs to be mapped in the Client Side Map Descriptors section Details on how to do this can be found below NOTE In the tables below indicates an optional parameter and bold legal values are defaults 5 1 Client Side Connection Parameters Sec...

Page 9: ...d by the FieldServer LIST_IDENTIFY Example Client Side Nodes Nodes Node_Name IP_Address Adapter Protocol PLC 1 192 168 1 174 N1 EtherNet IP 5 3 Client Side Map Descriptor 5 3 1 FieldServer Related Map Descriptor Parameters Column Title Function Legal Values Map_Descriptor_Name Name of this Map Descriptor Up to 32 alphanumeric characters Data_Array_Name Name of Data Array where data is to be stored...

Page 10: ...in certain PLC s Paths vary and are dependent on the structure of the network Any space delimited numerical value Refer to vendor s device documentation Appendix A 3 EIP_Data_Type This parameter should be used to force the data type of the attribute to match the data type used in the remote device Value Alias as used in PLC Float REAL Uint32 DINT Uint16 INT BYTE SINT default INT Length Number of d...

Page 11: ...f this parameter is not specified the Data Type of the Data Array will be used Refer to Appendix A 4 for more information Data Types can be specified in either FieldServer or Rockwell Data Type Refer to Appendix C 4 for more information Value Alias as used in PLC Float REAL Uint32 DINT Uint16 INT BYTE SINT BIT BOOL BOOLEAN Length Number of data elements to be mapped If the number of data elements ...

Page 12: ...information For any given Map Descriptor there can be 200 floats 400 integers or 800 bytes Address Address in the file Any valid numerical value between 0 to 255 5 3 5 Driver Related Map Descriptor Parameters Implicit IO Messages Column Title Function Legal Values EIP_Con_Typ The type of data transfer required Also referred to as the Transport Method Implicit EIP_Class EIP class to be polled Integ...

Page 13: ...ple 4 Implicit IO Messages Client Side Map Descriptors Map_Descriptors Map_Descriptor_Name Scan_Interval Data_Array_Name Data_Array_Offset Function EIP_Con_Typ Node_Name EIP_Class Address Length Parent_Map_Descriptor EIP_Real_Time_Format CMD_Producer 1s DA_OUTPUTS 0 Wrbc Implicit EIP_01 4 101 3 CMD_Consumer 1s DA_INPUTS 0 Passive Implicit EIP_01 4 102 8 CMD_Producer CMD_Config DA_Config 0 Passive ...

Page 14: ...de Connection Parameters Section Title Connections Column Title Function Legal Values Adapter Adapter Name N1 N23 Protocol Specify protocol used EtherNet IP UDP_Local_IO_Port Specify if it is required to receive implicit IO messages on the non default port 1 65534 2222 Example Server Side Connections Adapters Adapter Protocol UDP_Local_IO_Port N1 EtherNet IP 2222 6 2 Server Side Node Parameters Se...

Page 15: ...ers Unconnected Messages Column Title Function Legal Values EIP_Service The action to be performed Get_Attrib Set_Attrib EIP_Class Class to be served 0 65535 default 0 refer to Appendix D 2 for commonly used classes EIP_Attribute Attribute associated with the class served 0 255 default 0 refer to Appendix D 2 for commonly used attributes EIP_Data_Type This parameter should be used to force the dat...

Page 16: ...Array will be used This is only applicable to Data Table Read when FieldServer is the Server Refer to Appendix A 4 for further information Float Uint16 Uint32 Bit Byte Boolean Length Number of data elements to be mapped If the number of data elements exceeds the Map Descriptor length the list of data elements will be truncated and an error message will be printed once per Map Descriptor Refer to A...

Page 17: ...e per Map Descriptor Refer to Appendix D for further information For any given Map Descriptor there can be 61 floats 122 integers or 244 bytes Address Address in the file Any valid numerical value between 0 to 255 6 3 5 Server Specific Map Descriptor Parameters Implicit IO Messages Column Title Function Legal Values EIP_Con_Typ The type of data transfer required Also referred to as the Transport M...

Page 18: ..._09 DA_AI_05 0 EIP_01 Passive Data_Table_Read Analog_in_3 2 SMD_PRO_10 DA_AI_06 0 EIP_01 Passive Data_Table_Read Analog_in_4 2 6 3 8 Map Descriptor Example 3 PCCC Messages Server Side Map Descriptors Map_Descriptors Map_Descriptor_Name Data_Array_Name Data_Array_Offset Function EIP_Con_Typ Node_Name EIP_Service File_Type File_Number Address Length SRV_AI_01 DA_F_01 0 Passive Explicit EIP_01 Exec_P...

Page 19: ...he data type under the parameter EIP_Data_Type Note that the EIP_DATA_TYPE parameter has meaning only for DATA_TABLE_WRITE where the FieldServer is the Client and for DATA_TABLE_READ where the FieldServer is the Server Appendix A 4 1 Transfer Binary Values Using EIP The standard FieldServer data types do not follow the same naming convention as Rockwell However it is possible to enter the data typ...

Page 20: ...scriptors Map_Descriptor_Name Data_Array_Name Data_Array_Offset Node_Name Function EIP_SERVICE EIP_TAG_NAME Length FS_TO_PLC_DATA DA_Read 0 EIP_01 Passive DATA_TABLE_READ Read_Data 20 PLC_TO_FS_DATA DA_Write 0 EIP_01 Passive DATA_TABLE_WRITE Write_Data 20 5 The Data Format should match the Data Type used in the PLC program and tags to prevent a mismatch in the display of the Data Values Number of ...

Page 21: ...ep 3 Write ladder logic to exercise a read and write message block NOTE It is important to use the ladder logic to ensure that only one message block can be executing at any time Tag length must be equal to or greater than the number of points being written read MESSAGE data type must be used Avoid using UDT Types The data will be read but the exact placement of the data in the tags and arrays wil...

Page 22: ...e example above Local PLC tag configured in the PLC tag list see example above Local PLC tag configured in the PLC tag list see example above Remote FieldServer tag configured in the FieldServer see example above Number of points transferred from FieldServer to PLC regardless of tag and array sizes Number of points transferred from PLC to FieldServer regardless of tag and array sizes EIP_Card is t...

Page 23: ... in the data table format The EIP_Tag_Name field contains the tag name referenced in the server and the EIP_Path field represents the path through different ports to the server Each port jump is separated by a space This field generally holds a backplane cpu slot combination DATA_TABLE_READ and DATA_TABLE_WRITE are the only legal values for EIP_SERVICE Note that this is by far the preferred method...

Page 24: ... 1 9 EtherNet IP N1 Client Side Map Descriptors Map_Descriptors Map_Descriptor_Name Scan_Interval Data_Array_Name Data_Array_Offset EIP_CON_TYP Node_Name Function EIP_SERVICE EIP_PATH EIP_TAG_NAME Length PLC_TO_FIELDSERVER 0 1 DA_Read 0 EXPLICIT EIP_01 Rdbc DATA_TABLE_READ 1 0 FS_Status 20 FIELDSERVER_TO_PLC 0 1 DA_Write 0 EXPLICIT EIP_01 Wrbc DATA_TABLE_WRITE 1 0 FS_Control 20 These are the PLC T...

Page 25: ...ion If any non zero integer is used in a Read Map Descriptor for EIP_Structure_Handle the value will be updated internally The Map Descriptor can then be browsed to obtain this value Other devices do not validate this field when the structure is written by the third party device A summary of the procedures to obtain this value is presented below FieldServer as a Client Read o Use a value of 1 the ...

Page 26: ... room3_temp Now he has his own type SSS_SINT3 and he can define tags TAG_3ROOM_TEMPS of type SSS_SINT3 Read write structures Map_Descriptors Map_Descriptor_Name Data_Array_Name Data_Array_Offset Function EIP_CON_TYP Node_Name EIP_SERVICE EIP_Path EIP_TAG_NAME EIP_Structure_Handle Length Scan_Interval CMD_Struct_SINT3 DA_STRUCT_R 0 Rdbc EXPLICIT EIP_01 DATA_TABLE_READ 1 0 TAG_3ROOM_TEMPS 59592 3 1 ...

Page 27: ... updates This example makes use of the Implicit messaging I O for passing data between the FieldServer and an Allen Bradley PLC The example shows configuration of a ControlLogix PLC but all Rockwell PLC s that support EtherNet IP communications and implicit I O messaging should be able to communicate this way When the PLC is configured it will open a connection to the FieldServer The Map Descripto...

Page 28: ...rNet IP Server Side Nodes Nodes Node_Name Node_ID Protocol IP_Address EIP_01 1 EtherNet IP 192 168 1 60 Server Side Map Descriptors Map_Descriptors Map_Descriptor_Name Data_Array_Name Data_Array_Offset Node_Name EIP_CON_TYP Function EIP_CLASS Address EIP_ATTRIBUTE Length MD_CONSUMER DA_INPUTS 0 EIP_01 IMPLICIT Server 4 101 3 100 MD_PRODUCER DA_OUTPUTS 0 EIP_01 IMPLICIT Server 4 102 3 100 Number of...

Page 29: ...ng 3 steps Add a Generic Ethernet Module Configure the Connection Parameters as per the screenshot below Enter the FieldServer s IP Address The PLC will produce and consume 10 16bit words but the FieldServer is configured for 100 words in case more data is needed The FieldServer will produce only as much data as requested by the PLC during session set up No further PLC programming is needed ...

Page 30: ...Net IP Driver Manual Page 30 of 42 Appendix A 8 2 EDS AOP Use Studio 5000 Logix Designer to do the following Choose the device to add to a project the AOP pick the implicit I O sizes and the I O SINT arrays ...

Page 31: ...EtherNet IP Driver Manual Page 31 of 42 ...

Page 32: ...EtherNet IP Driver Manual Page 32 of 42 ...

Page 33: ...S File 1 Save the fserver eds file on the local PC 2 Launch Studio5000 3 Click on the Tools dropdown menu and select the EDS Hardware Installation Tool 4 Follow the instructions and select the fserver eds file 5 In the Controller Organizer window right click on Ethernet then click on New Module ...

Page 34: ...42 6 Select the FieldServer EIP Adapter entry and press the Create button 7 On the General tab specify the module name any string and enter the IP Address of the FieldServer Then press the Change button under the Module Definition heading ...

Page 35: ...ze format of the FieldServer configuration NOTE By default Studio5000 will create tags in SINT format 9 Click on the numbers under the Size header to change the size 10 Then click OK when adjusted appropriately NOTE To adjust how often data will be created optional select the Connection tab in the New Module window and adjust the RPI setting as needed ...

Page 36: ... 42 11 Once all desired settings are configured in the New Module window click OK This will create the FieldServer module under the Ethernet tree And Studio5000 will create the corresponding tags 12 Finally download the project to the PLC ...

Page 37: ...rmware and continuously get failed messages it might be due to the traffic on the N1 or N2 ports EtherNet IP is a high traffic protocol and once a connection is created continuous data transfer occurs In this situation the best way to download new firmware would be to manually disconnect the scanner or adapter connected to the FieldServer ...

Page 38: ...ts from the same file type to another array etc Read Blocks must be contiguous Appendix C 3 FieldServer Not Recognized by RSlinx If RSlinx does not recognize the FieldServer message Unrecognized Device load the EtherNet IP EDS file into RSLinx This file is available on the Sierra Monitor website s software downloads Press Start all programs Rockwell Software RSlinx tools EDS Hardware Installation ...

Page 39: ...tes and services The data types listed below are to be considered as the objects supported in the protocol Each of these has attributes that have been supported to differing degrees FieldServer Data Type Description or Device Data Type Identity Class Code 0x01 Attributes Supported One instance supported 0x01 Attributes List Vendor ID Device Type Product Code Device Revision Status Serial Number De...

Page 40: ... Point Class Code 0x0B Attributes Supported Class Instance Support 0x00 Class Attributes 0x02 Max Instance Two instances supported 0x01 and 0x02 Attributes List Number of Attributes Analog value UINT16 Vendor ID Services Supported Set_Attribute_Single Get_Attribute_Single TCP IP Interface Object Class Code 0xF5 Attributes Supported One instance supported 0x01 Attributes List Status Configuration C...

Page 41: ... 0x01 0x0203 Connection cannot be closed since the connection has timed out 0x01 0x0204 Unconnected Send timed out waiting for a response 0x01 0x0205 Parameter Error in Unconnected Send Service 0x01 0x0206 Message too large for Unconnected message service 0x01 0x0207 Unconnected acknowledge without reply 0x01 0x0301 No buffer memory available 0x01 0x0302 Network Bandwidth not available for data 0x...

Page 42: ...present in the Data Segment shall always be index 1 If the error occurs with the Get Set Services then the extended status indicates the attribute number that failed 0x0C Optional Service cannot be performed while Object is in current state The 1st word of Extended Status may optionally contain the object s current state 0x10 Optional Service cannot be performed while Device is in current state Th...

Reviews: