Using Explicit Messaging
Contents
1. Instance Attributes Attribute Acces ID s Rule Name Data Type Description 1 Get Vendor ID UINT 1 Allen Bradley 2 Get Device Type UINT 127 3 Get Product Code UINT Number identifying product name and rating 4 Get Revision STRUCT of Major USINT Value varies Minor USINT Value varies 5 Get Status WORD Bit 0 Owned Bit 2 Configured Bit 10 Recoverable fault Bit 11 Unrecoverable fault 6 Get Serial Number UDINT Unique 32 bit number 7 Get Product Name SHORT_ STRING Product name and rating 9 Get Configuration UINT CRC or checksum Consistency representing the configuration Value of the product 100 Get NVS Info STRUCT of UDINT First NVS instance SHORT_STRING Sub assembly name Services Service Code _ Implemented for Service Name Class Instance 0x01 Yes Yes Get_Attributes_All 0x05 No Yes Reset Ox0E Yes Yes Get_Attribute_Single EtherNet IP Objects Assembly Object Class Code Hexadecimal Decimal 0x04 4 Instances Instance Description 1 All I O data being read from the DSI drives read only 2 All O data written to the DSI drives read write Class Attributes Attribute ID Access Rule Name Data Type Description 1 Get Revision UINT 2 2 Get Max Instance UINT 2 100 Set Control UINT Control timeout in seconds Timeout Instance Attributes Attribute ID Access Rule Name Data Type Description 1 Get Number of UINT 1 Members 2 Get Member List ARRAY of STRUCT2. UINT Size of member data UINT Size of member path Packed Member path EPATH 3 Conditional Data Array of Bits Data to be transferred 4 Get Size UINT Size of assembly data in bits 1 For instance 1 access rule for the data attribute is Get For instance 2 it is Get Set Important Setting an Assembly object attribute can be done only when the Control Timeout class attribute 100 has been set to a non zero value Assembly Object Continued EtherNet IP Objects C 5 Services Implemented for Service Code Class Instance Service Name Ox0E Yes Yes Get_Attribute_Single 0x10 Yes Yes Set_Attribute_Single EtherNet IP Objects Register Object Class Code Hexadecimal Decimal 0x07 7 Instances Instance Description Qum i an 1 Logic Command and Reference for all drives Out Varies l 2 Logic Status and Feedback for all drives In Varies 3 Logic Command and Reference for Drive 0 Out 32 4 Logic Status and Feedback for Drive 0 In 32 5 Logic Command and Reference for Drive 1 Out 32 6 Logic Status and Feedback for Drive 1 In 32 7 Logic Command and Reference for Drive 2 Out 32 8 Logic Status and Feedback for Drive 2 In 32 9 Logic Command and Reference for Drive 3 Out 32 10 Logic Status and Feedback for Drive 3 In 32 11 Logic Command and Reference for Drive 4 Out 32 12 Logic Status and Feedback for Drive 4 In 32 13 Logi
3. UDINT ASA serial number Serial UDINT ASA serial number Number of requestor Number of requestor Other Product Identifier of user Other Product Identifier of user Specific task etc on the Specific task etc on the requestor requestor CMD USINT Command byte CMD USINT Command byte C 16 EtherNet IP Objects PCCC Object Continued Message Structure for Execute PCCC Continued Request Response Data Data Name Type Description Name Type Description STS USINT O STS USINT Status byte TNSW UINT Transport word TNSW UINT Transport word Same value as the request FNC USINT Function code Not EXT STS USINT Extended status used for all CMD s Not used for all CMD s PCCC ARRAY of CMD FNC specific PCCC___ ARRAY of CMD FNC specific params USINT parameters results USINT result data Message Structure for Execute_DH Request Response Data Data Name Type Description Name Type Description DLink UINT Destination Link ID DLink UINT Destination Link ID DSta USINT Destination Station DSta USINT Destination Station number number DUser USINT Destination User DUser USINT Destination User number number SLink UINT Source Link ID SLink UINT Source Link ID SSta USINT Source Station SSta USINT Source Station number number SUser USINT Source User SUser USINT Source User number number CMD USINT Command byte CMD USINT Command by
4. 1 999 Not supported Drive 4 parameters 1 999 N18 0 Not supported Number of parameters in this adapter N18 1 999 Not supported Parameters 1 999 in this adapter DPI Device Object Class Code Hexadecimal Decimal 0x92 146 Instances EtherNet IP Objects C 21 The number of instances depends on the number of components in the device The total number of components can be read in Instance 0 Class Attribute 4 Instances Dec 0 16383 Single Drive Mode Instances 0 16383 in the drive Multi Drive Mode Instances 0 16383 in Drive 0 16384 17407 Instances 0 1023 in the adapter Instances 0 1023 in the adapter 17408 18431 Instances 0 1023 in the adapter Instances 0 1023 in Drive 1 18432 19455 Instances 0 1023 in the slave Instances 0 1023 in Drive 2 19456 20479 Not supported Instances 0 1023 in Drive 3 20480 21503 Not supported Instances 0 1023 in Drive 4 21504 22527 Not supported Instances 0 1023 in the adapter Class Attributes Attribute Access ID Rule Name Data Type Description 0 Get Family Code BYTE Code identifying the device 1 Get Family Text STRING 16 Text identifying the device 2 Set Language Code BYTE 0 English 1 French 2 Spanish 3 Italian 4 German 5 Japanese 6 Portuguese 7 Mandarin Chinese 8 Russian 9 Dutch 3 Get Product Series BYTE 1 A 2 B 4 Get
5. 23 DPI Device Object Continued Instance Attributes Attribute Access ID Rule Name Data Type Description 3 Get Component STRING 32 Name of the component Name 4 Get Component STRUCT of Firmware BYTE Major Revision Revision BYTE Minor Revision 5 Get Component BYTE Hardware Change Number 8 Get Component DWORD Value between 0x00 and Serial Number OxFFFFFFFF Services Implemented for Service Code Class Instance Service Name Ox0E Yes Yes Get_Attribute_Single 0x10 Yes Yes Set_Attribute_Single C 24 EtherNet IP Objects DPI Parameter Object Class Code Hexadecimal Decimal 0x93 147 Instances The number of instances depends on the number of parameters in the device The total number of parameters can be read in Instance 0 Attribute 0 Instances Dec 0 16383 Single Drive Mode Instances 0 16383 in the drive Multi Drive Mode Instances 0 16383 in Drive 0 16384 17407 Instances 0 1023 in the adapter Instances 0 1023 in the adapter 17408 18431 Instances 0 1023 in the adapter Instances 0 1023 in Drive 1 18432 19455 Instances 0 1023 in the slave Instances 0 1023 in Drive 2 19456 20479 Not supported Instances 0 1023 in Drive 3 20480 21503 Not supported Instances 0 1023 in Drive 4 21504 22527 Not supported Instances 0 1023 in the adapter Class Attributes Attri
6. Instances The adapter supports one instance of the TCP IP Interface object Number Description 0 Class Attributes 1 Object Attributes Class Attributes Attribute Access ID Rule Data Type Description 1 UINT The revision of this object Instance Attributes Attribute Access ID Rule Name Data Type Description 1 Get Interface UDINT Speed in megabits per second Mbps Speed 2 Get Interface DWORD Bit Value Flags 0 Link status 0 inactive 1 active 1 Duplex 0 half duplex 1 full duplex 2 to 31 Reserved 3 Get Physical USINT 6 MAC address XX XX XX XX XX XX Address The first octet USINT 0 is on the left EtherNet IP Objects C 35 Ethernet Link Object Continued Instance Attributes Continued Attribute Access ID Rule Name Data Type Description 4 Get Interface STRUCT of Counters UDINT Octets received UDINT Unicast packets received UDINT Non unicast packets received UDINT Inbound packets received but discarded UDINT Inbound packets with errors not discarded UDINT Inbound packets with unknown protocol UDINT Octets sent UDINT Unicast packets sent UDINT Non unicast packets sent UDINT Outbound packets discarded UDINT Outbound packets with errors 5 Get Media STRUCT of RX Received TX Transmitted Counters UDINT RX frames not having integral number of octets long UDINT RX frames not passing FCS
7. box which grays out unavailable Using Explicit Messaging 6 7 Example Ladder Logic Rung Figure 6 5 Example Get Attribute Single Message Explicit Messaging Example Reading a single parameter Get Attribute Single command PerformParameterRead MSG 13 jE Type CIP Generic E Message Control ParameterReadMessage CDN gt I ERS Example Destination Data In this example the Get Attribute Single message reads Parameter 39 Accel Time 1 in the PowerFlex 40 drive and returns its value to the destination tag named ParameterRead Value Figure 6 6 Example Destination Data from a Get Attribute Single Message ParameterReadValue 100 Decimal INT The acceleration time is 10 0 seconds 6 8 Using Explicit Messaging Example Set Attribute Single Message A Set Attribute Single message writes a value for a single attribute In this example we write the value of a parameter in a PowerFlex 40 drive Example Message Format Figure 6 7 Message Format for a Set Attribute Single Message Message Configuration ParameterWriteMessage E X Configuration Communication Tag Name ParameterwiteMessage x Configuration Communication Tag Path PF40_Demo Browse x Configuration Communication Tag l Message Type ime Set Attribute Single v Source Element ParameteiwriteValue ype Source Length 2 Bytes Code 10 Hex Class If Hex De E Jj Instance
8. new tag for the message properties Base tag type MESSAGE data type controller scope and click the blue box inside the message Using Explicit Messaging 6 3 ControlLogix Message Requests and Responses Box Description Q Message Type The message type must be CIP Generic Service Type The service type indicates the service for example Get Attribute Single or Set Attribute Single that you want to perform Available services depend on the class and instance that you are using Refer to Appendix C EtherNet IP Objects Service Code The service code is the code for the requested EtherNet IP service This value changes based on the Service Type that has been selected In most cases this is a read only box If you select Custom in the Service Type box then you need to specify a service code in this box for example 4B for a Get Attributes Scattered service or 4C for a Set Attributes Scattered service Class The class is an EtherNet IP class Refer to Appendix C EtherNet IP Objects for available classes Q Instance The instance is an instance or object of an EtherNet IP class Refer to Appendix C EtherNet IP Objects for available instances for each class Attribute The attribute is a class or instance attribute Refer to Appendix C EtherNet IP Objects for available attributes for each class or instance Source Element This box contains the name of the tag for an
9. s buffer upload The Explicit Message is complete Using Explicit Messaging 6 5 About the Example Explicit Messages These examples show how to format and execute the following types of Explicit Messages using a ControlLogix controller e Get Attribute Single e Set Attribute Single Message Formats When formatting an example message refer to Formatting Explicit Messages in this chapter for an explanation of the content of each box Also to format and execute these example messages you need the Controller tags displayed in Figure 6 3 Figure 6 3 Controller Tags for Explicit Messages Scope EtherNetIP_Demofe x Show Show Al Sort Tag Name P Tag Name MESSAGE ParameterReadValue INT ParameterwriteMessage MESSAGE i m ParameterwriteValue INT I PF40_Demo C AB ETHERNET_ PF40_Dema l AB ETHERNET_ PF40_Demo 0 AB ETHERNET_ Ladder Logic Rungs The ladder logic rungs for the examples in this chapter can be appended after rung 12 in the ladder logic program Figure 5 5 in Chapter 5 Using I O Messaging Source and Destination Data The example values for the source and destination data that appear in this chapter may vary in your application 6 6 Using Explicit Messaging Example Get Attribute Single Message A Get Attribute Single message reads a single attribute value In this ex
10. 33 Attribute 1 Hex NEWER elp Q Enable Enable Waiting Start Done Done Length 0 O Error Code Extended Error Code Timed Out Error Path Error Text Cancel Apply Help The following table identifies key settings for the data format Configuration Value Description Refer to Service Type Set Attribute Single Write parameter data C 27 Service Code l 10 Hex Set Attribute Single Ci Class f Hex DSI Parameter Object C 24 Instance 39 Dec Parameter 39 Accel Time 1 C 24 Attribute 1 Hex Parameter Value C 25 Source Element ParameterWriteValue Controller tag for write data Source Length 2 bytes One 16 bit word of data is sent 1 The default setting for Service Type is Custom which enables you to enter a Service Code that is not available from the Service Type pulldown menu When you select a Service Type other than Custom from the pulldown menu an appropriate Hex value is automatically assigned to the Service Code box which grays out unavailable Using Explicit Messaging 6 9 Example Ladder Logic Rung Figure 6 8 Example Set Attribute Single Message Explicit Messaging Example Writing a single parameter Set Attribute Single command PerformParameterWrite 3E s MSG Example Source Data Type CIP Generic Message Control I E ParameterWriteMessage DN5 CEFO In this example the Set Attribute Single message wr
11. 41 0 Logic Command Word Logic Status Word N41 1 Unused Unused N41 2 Reference Feedback N42 This N file lets you read and write some values configuring the port N42 3 Time out read write Time in seconds allowed between messages to the N41 or N44 file If the adapter does not receive a message in the specified time it performs the fault action configured in its Comm Fit Action parameter N42 7 Adapter Port Number read only DPI port on the drive to which the adapter is connected N42 8 Peer Adapters read only Bit field of devices having DPI Peer capabilities EtherNet IP Objects C 19 PCCC Object Continued N Files Continued N File Description For Multi Drive Mode Only N44 This N file lets you read and write control MO messages You can write control I O messages only when all of the following conditions are true e The adapter is not receiving I O from a scanner For example there is no scanner on the network the scanner is in idle program mode the scanner is faulted or the adapter is not mapped to the scanner e The value of N42 3 is set to a non zero value Write Read N44 0 Drive 0 Logic Command Drive 0 Logic Status N44 Unused Unused N44 2 Drive 0 Reference Drive 0 Feedback N44 3 Drive 1 Logic Command Drive 1 Logic Status N44 4 Drive 1 Reference Drive 1 Feedback N44 5 Drive 2 Logic Command Drive 2 Logic Status N44 6 Drive 2 Reference Drive 2 Feedback N44 7 Drive 3 Logic Command Drive 3 Logic
12. Allen Bradley EtherNet IP Adapter 22 COMM E FRN 1 xxx User Manual Automation gt Chapter 6 Using Explicit Messaging Chapter 6 provides information and examples that explain how to use Explicit Messaging to configure and monitor the EtherNet IP adapter installed and connected to the PowerFlex 40 drive Topic Page Topic Page About Explicit Messaging 6 1 About the Example Explicit Messages 6 5 Formatting Explicit Messages 6 2 Example Get Attribute Single Message 6 6 Performing Explicit Messages 6 4 Example Set Attribute Single Message 6 8 ATTENTION Risk of injury or equipment damage exists The examples in this publication are intended solely for purposes of example There are many variables and requirements with any application Rockwell Automation Inc does not assume responsibility or liability to include intellectual property liability for actual use of the examples shown in this publication ATTENTION Risk of equipment damage exists If Explicit Messages are programmed to write parameter data to Non Volatile Storage NVS frequently the NVS will quickly exceed its life cycle and cause the drive to malfunction Do not create a program that frequently uses Explicit Messages to write parameter data to NVS Refer to Chapter 5 for information about the I O image using Logic Command Status and Reference Feedback About Explicit Messaging Explicit Messaging is used to transfer dat
13. Number of BYTE Number of components e g main control Components board I O boards in the device C 22 EtherNet IP Objects DPI Device Object Continued Class Attributes Continued Attribute Access ID Rule Name Data Type Description 5 Set User Definable STRING 16 Text identifying the device with a Text user supplied name 6 Get Status Text STRING 12 Text describing the status of the device 7 Get Configuration BYTE Identification of variations Code 8 Get Configuration Text STRING 16 Text identifying a variation of a family device 9 Get Brand Code WORD 0x0001 Allen Bradley 11 Get NVS Checksum WORD Checksum of the Non Volatile Storage ina device 12 Get Class Revision WORD 2 DPI 13 Get Character Set BYTE 0 SCANport HIM Code 1 ISO 8859 1 Latin 1 2 ISO 8859 2 Latin 2 3 ISO 8859 3 Latin 3 4 ISO 8859 4 Latin 4 5 ISO 8859 5 Cyrillic 6 ISO 8859 6 Arabic 7 ISO 8859 7 Greek 8 ISO 8859 8 Hebrew 9 ISO 8859 9 Turkish 10 ISO 8859 10 Nordic 255 ISO 10646 Unicode 15 Get Languages STRUCT of Supported BYTE Number of Languages BYTE n Language Codes See Class Attribute 2 16 Get Date of STRUCT of Manufacture WORD Year BYTE Month BYTE Day 17 Get Product Revision STRUCT of BYTE Major Firmware Release BYTE Minor Firmware Release 18 Get Serial Number DWORD Value between 0x00 and OxFFFFFFFF EtherNet IP Objects C
14. Status N44 8 Drive 3 Reference Drive 3 Feedback N44 9 Drive 4 Logic Command Drive 4 Logic Status N44 10 Drive 4 Reference Drive 4 Feedback C 20 EtherNet IP Objects PCCC Object Continued N Files Continued Important If your controller or HMI platform supports CIP messaging use the CIP Parameter object to get and set parameters N File Description N10 N18 These N files let you read and write parameter values in the drive and the adapter Single Drive Mode Multi Drive Mode N10 0 Number of parameters in the drive Number of parameters in Drive 0 N10 1 999 Drive parameters 1 999 Drive 0 parameters 1 999 N11 0 999 Drive parameters 1000 1999 Drive 0 parameters 1000 1999 N12 0 999 Drive parameters 2000 2999 Drive 0 parameters 2000 2999 N13 0 Number of parameters in this Number of parameters in this adapter adapter N13 1 999 Parameters 1 999 in this adapter Parameters 1 999 in this adapter N14 0 Number of parameters in this Number of parameters in Drive 1 adapter N14 999 Parameters 1 999 in this adapter Drive 1 parameters 1 999 N15 0 Number of parameters in the slave Number of parameters in Drive 2 N15 1 999 Parameters 1 999 in the slave Drive 2 parameters 1 999 N16 0 Not supported Number of parameters in Drive 3 N16 1 999 Not supported Drive 3 parameters 1 999 N17 0 Not supported Number of parameters in Drive 4 N17
15. a that does not require continuous updates With Explicit Messaging you can configure and monitor a slave device s parameters on the EtherNet IP network 6 2 Using Explicit Messaging Formatting Explicit Messages Explicit Messages for the ControlLogix Controller ControlLogix scanners and bridges accommodate both downloading Explicit Message Requests and uploading Explicit Message Responses The scanner or bridge module can accommodate one request or response for each transaction block Each transaction block must be formatted as shown in Figure 6 1 Figure 6 1 ControlLogix Message Format in RSLogix 5000 Message Configuration DriveMessageControl x Configuration Communication Tag Name jl Message Configuration DriveMessageControl E Configuration Communication Tag l ea ooo O Message Configuration DriveMessageControl zik 1 Configuration Communication Tag Message Type E Service 2 Source Element 7 Type Source Length 93 IER Servi 3 Service Hen Class E He Destination IO Help Instance O Aibue G Hex Nee O Enable Q Enable Waiting O Start O Done Done Length 0 Eror Code Extended Error Code T Timed Out Error Path Error Text Cancel r Help Refer to page 6 3 for a description of the data that is required in each box 1 11 TIP To display the Message Configuration dialog box in RSLogix 5000 add a message instruction MSG create a
16. ample we read the value of a parameter in a PowerFlex 40 drive Example Message Format Figure 6 4 Message Format for a Get Attribute Single Message Message Configuration ParameterReadMessage E x Configuration Communication Tag Name ParameterHeadMessagel xi Configuration Communication Tag Path Browse xi Configuration Communication Tag meum Service Get Attribute Single E Source Element Type Source Length 0 Bytes Code IE We coo f Hes Destination ParameterReadValue w Instance 39 Attribute 1 Hex pm lp O Enable Enable Waiting Start Done Done Lenath 2 Q Error Code Extended Error Code Timed Out Error Path Error Text Cancel Apply Help The following table identifies key settings for the message format Configuration Refer to Service Type 1 Get Attribute Single Read parameter data C 27 Service Code e Hex Get_Attribute_Single 3 Class f Hex DSI Parameter Object C 24 Instance 39 Dec Parameter 39 Accel Time 1 C 24 Attribute 1 Hex Parameter Value C 25 Destination ParameterReadValue Controller tag for response data 1 The default setting for Service Type is Custom which enables you to enter a Service Code that is not available from the Service Type pulldown menu When you select a Service Type other than Custom from the pulldown menu an appropriate Hex value is automatically assigned to the Service Code
17. bute Access ID Rule Name Data Type Description 0 Get Number of WORD Number of parameters in the device Instances 1 Set Write Protect WORD 0 Password disabled Password n Password 2 Set NVS Command BYTE 0 No Operation Write 1 Store values in active memory to NVS 2 Load values in NVS to active memory 3 Load default values to active memory 3 Get NVS Parameter WORD Checksum of all parameter values in a Value Checksum user set in NVS 4 Get NVS Link Value WORD Checksum of parameter links in a user set Checksum in NVS 5 Get First Accessible WORD First parameter available if parameters are Parameter protected by passwords A 0 indicates all parameters are protected 7 Get Class Revision WORD 2 DPI 8 Get First Parameter WORD The first parameter that has been written Processing Error with a value outside of its range A 0 indicates no errors 9 Set Link Command BYTE 0 No Operation 1 Clear All Parameter Links This does not clear links to function blocks EtherNet IP Objects C 25 DPI Parameter Object Continued Instance Attributes Attribute Access ID Rule Name Data Type Description 7 Get DPI Online Read STRUCT of Full BOOL 32 Descriptor Refer to pages C 26 C 27 CONTAINER Parameter value CONTAINER Minimum value CONTAINER Maximum value CONTAINER Default value WORD Next parameter WORD Previous parameter STRING 4 Units e g Amp H
18. c Command for all drives mask and match register Out Varies 14 Logic Command for Drive 0 mask and match register Out 32 15 Logic Command for Drive 1 mask and match register Out 32 16 Logic Command for Drive 2 mask and match register Out 32 17 Logic Command for Drive 3 mask and match register e Out 32 18 Logic Command for Drive 4 mask and match register e Out 32 19 Logic Command for Drive 0 Out 16 20 Logic Status for Drive 0 In 16 21 Reference for Drive 0 Out 16 22 Feedback for Drive 0 In 16 23 Logic Command for Drive 1 Out 16 24 Logic Status for Drive 1 In 16 25 Reference for Drive 1 Out 16 26 Feedback for Drive 1 In 16 1 The size for this Register Object instance is 32 bits per drive For example if the adapter is operating in Multi Drive mode and is configured with Drives 0 through 4 then the size is 160 bits The structure for this Register Object instance is a Mask word followed by a Command word for each drive The Logic Command for each drive is set to the value of the second word of the data where there are ones in the first word of the data Logic Command Logic Command and not Mask word or Command word and Mask word EtherNet IP Objects C 7 Register Object Continued Instances Continued Instance Description Dun w aT 27 Logic Command for Drive 2 Out 16 28 Logic Status for Drive 2 In 16 29 Reference for Drive 2 Out 16 30 Fe
19. check UDINT TX frames having one collision UDINT TX frames having multiple collisions UDINT Number of times of SQE test error message UDINT TX Frames delayed first attempt by busy medium UDINT Collisions detected later than 512 bit times in trans UDINT TX frames failing due to excessive collisions UDINT TX frames failing due to intern MAC sublayer TX error UDINT Times of carrier sense condition loss during trans UDINT RX frames exceeding the maximum frame size UDINT _ RX frames failing due to intern MAC sublayer RX error Services Implemented for Service Code Class Instance Service Name Ox0E Yes Yes Get_Attribute_Single 0x4C No Yes Get_and_Clear C 36 EtherNet IP Objects Notes
20. cription BYTE 8 bit unsigned integer WORD 16 bit unsigned integer DWORD 32 bit unsigned integer LWORD 64 bit unsigned integer SINT 8 bit signed integer USINT 8 bit unsigned integer INT 16 bit signed integer UINT 16 bit unsigned integer DINT 32 bit signed integer UDINT 32 bit unsigned integer BOOL 8 bit value low bit is true or false BOOL n Array of n bits STRING n Array of n characters SHORT_STRING 1 byte length indicator that many characters STRUCT Structure name only no size in addition to elements CONTAINER 32 bit parameter value sign extended if necessary TCHAR 8 or 16 bit character REAL 32 bit floating point C 2 EtherNet IP Objects Identity Object Class Code Hexadecimal Decimal 0x01 1 Instances Single Drive Mode The number of instances is fixed at three and is as shown below Instance Description 0 Class 1 Host drive 2 22 COMM E 3 22 SCM 232 or 22 HIM when present Instances Multi Drive Mode The number of instances is fixed at one and is as shown below Instance Description 0 Class 1 22 COMM E Class Attributes Attribute Access ID Rule Name Data Type Description 1 Get Revision UINT 1 2 Get Max Instance UINT Total number of instances 6 Get Max ID Number UINT 7 of Class Attributes 7 Get Max ID Number UINT 100 of Instance Attributes EtherNet IP Objects C 3 Identity Object Continued
21. cts C 9 Parameter Object Class Code Hexadecimal Decimal OxOF 15 Instances Single Drive Mode The number of instances is as shown below Instance Description 0 Class 1 Drive Parameter 1 t t n Drive Parameter n n 1 Adapter Parameter 1 t t nem Adapter Parameter m 1 n represents the number of parameters in the drive 8 m represents the number of parameters in the adapter Instances Multi Drive Mode The number of instances is as shown below Instance Description 0 Class 1 Adapter Parameter 1 t t m Adapter Parameter m 1 0 m represents the number of parameters in the adapter In addition the parameters for the other DSI devices can be accessed using the instance offset encoding shown in the table below Instances Dec 16384 17407 Single Drive Mode Instances 0 1023 in the adapter Multi Drive Mode Instances 0 1023 in the adapter 17408 18431 Instances 0 1023 in the drive Instances 0 1023 in Drive 0 18432 19455 Not supported Instances 0 1023 in Drive 1 19456 20479 Not supported Instances 0 1023 in Drive 2 20480 21503 Not supported Instances 0 1023 in Drive 3 21504 22527 Not supported Instances 0 1023 in Drive 4 C 10 EtherNet IP Objects Parameter Object Continued Class Attributes Attribute Access ID Rule Name Data Type Description 1 Get Revis
22. edback for Drive 2 In 16 31 Logic Command for Drive 3 Out 16 32 Logic Status for Drive 3 In 16 33 Reference for Drive 3 Out 16 34 Feedback for Drive 3 In 16 35 Logic Command for Drive 4 Out 16 36 Logic Status for Drive 4 In 16 37 Reference for Drive 4 Out 16 38 Feedback for Drive 4 In 16 Class Attributes Attribute Access ID Rule Name Data Type Description 1 Get Revision UINT 1 2 Get Max Instance UINT 38 3 Get Number of Instances UINT 38 100 Set Control Timeout UINT Control timeout in seconds EtherNet IP Objects Register Object Continued Instance Attributes Attribute ID Access Rule Name Data Type Description 1 Get Bad Flag BOOL If set to 1 then attribute 4 contains invalid bad or otherwise corrupt data 0 good 1 bad 2 Get Direction BOOL Direction of data transfer 0 Input Drive to EtherNet IP 1 Output EtherNet IP to Drive 3 Get Size UINT Size of register data in bits 4 Conditional Data ARRAY of Data to be transferred BITS 1 The access rule of Set is optional if attr access rule is Get ibute 2 Direction 1 If Direction 0 the Important Setting a Register object attribute can be done only when the Control Timeout class attribute 100 has been set to a non zero value Implemented for Service Code Class Instance Service Name Ox0E Yes Yes Get_Attribute_Single 0x10 Yes Yes Set_Attribute_Single EtherNet IP Obje
23. ion UINT 1 2 Get Max Instance UINT Number of parameters 8 Get Parameter WORD 0 False 1 True Class Bit 0 Supports parameter instances Descriptor Bit 1 Supports full attributes Bit 2 Must do NVS save command Bit 3 Parameters are stored in NVS 9 Get Configuration UINT 0 Assembly Instance 10 Get Native USINT 0 English Language 1 French 2 Spanish 3 Italian 4 German 5 Japanese 6 Portuguese 7 Mandarin Chinese 8 Russian 9 Dutch EtherNet IP Objects C 11 Parameter Object Continued Instance Attributes Attribute Access ID Rule Name Data Type Description 1 U Parameter Value 3 2 Get Link Path Size USINT 0 No link specified n The size of Attribute 3 in bytes 3 Get Link Path 4 4 Get Descriptor WORD 0 False 1 True Bit 1 Supports ENUMs Bit 2 Supports scaling Bit 3 Supports scaling links Bit 4 Read only Bit 5 Monitor Bit 6 Extended precision scaling 5 Get Data Type USINT OxC2 SINT 8 bits 0xC3 INT 16 bits 0xC4 DINT 32 bits 0xC6 USINT 8 bits 0xC7 UINT 16 bits OxCA REAL 32 bits 0xD2 WORD 16 bits 6 Get Data Size USINT 7 Get Parameter Name SHORT 9 String STRING 8 Get Units String SHORT_ STRING 9 Get Help String SHORT Nullstring STRING 10 Get Minimum Value 3 11 Get Maximum Value 3 12 Get Default Value 1 3 13 Get Scaling M
24. ites 100 the value in the source tag named ParameterWriteValue to Parameter 39 Accel Time 1 in the PowerFlex 40 drive Figure 6 9 Example Source Data from a Set Attribute Single Message L e ParameterwriteValue 100 Decimal INT 10 0 seconds is written to the parameter 6 10 Using Explicit Messaging Notes Appendix C EtherNet IP Objects Appendix C provides information about the EtherNet IP objects that can be accessed using Explicit Messages For information on the format of Explicit Messages and example ladder logic programs refer to Chapter 6 Using Explicit Messaging Class Code Class Code Object Hex Dec Page Object Hex Dec Page Identity Object 0x01 1 C 2 DPI Device Object 0x92 146 C 21 Assembly Object 0x04 4 C 4 DPI Parameter Object 0x93 147 C 24 Register Object 0x07 7 C 6 DPI Fault Object 0x97 151 C 28 Parameter Object OxOF 15 C 9 DPI Diagnostic Object 0x99 153 C 30 Parameter Group Object Ox10 16 C 13 TCP IP Interface Object OxF5 245 C 32 PCCC Object 0x67 103 C 15 Ethernet Link Object OxF6 246 C 34 p TIP Refer to the EtherNet IP specification for more information about EtherNet IP objects Information about the EtherNet IP specification is available on the ODVA web site http www odva org Supported Data Types Data Type Des
25. lass Instance Service Name Ox0E Yes Yes Get_Attribute_Single 0x10 Yes Yes Set_Attribute_Single C 30 EtherNet IP Objects DPI Diagnostic Object Class Code Hexadecimal Decimal 0x99 153 Instances The number of instances depends on the maximum number of diagnostic items in the device The total number of diagnostic items can be read in Instance 0 Attribute 2 Instances Dec 0 16383 Single Drive Mode Multi Drive Mode Instances 0 16383 in Drive 0 Instances 0 16383 in the drive 16384 17407 Instances 0 1023 in the adapter Instances 0 1023 in the adapter 17408 18431 Instances 0 1023 in the adapter Instances 0 1023 in Drive 1 18432 19455 Instances 0 1023 in the slave Instances 0 1023 in Drive 2 19456 20479 Not supported Instances 0 1023 in Drive 3 20480 21503 Not supported Instances 0 1023 in Drive 4 21504 22527 Not supported Instances 0 1023 in the adapter Class Attributes Attribute Access ID Rule Name Data Type Description 1 Get Class Revision WORD 1 2 Get Number of WORD Number of diagnostic items in the Instances device 3 Get ENUM Offset WORD DPI ENUM object instance offset EtherNet IP Objects C 31 DPI Diagnostic Object Continued Instance Attributes Attribute Access ID Rule Name Data Type Description 0 Get Full All Info STRUCT of BOOL 32 Descriptor Refer to page
26. nfiguration DWORD Bit Value 0 False 1 True Capability 0 Supports BOOTP 1 DNS Client Able to resolve host names by query to DNS server 2 DHCP Client Able to obtain network configuration through DHCP 3 DHCP DNS Update Able to send its host name in the DHCP request 4 Configuration Settable Able to set the network configuration via TCP IP 5 to 31 Reserved TCP IP Interface Object Continued Instance Attributes Continued EtherNet IP Objects C 33 Attribute Access ID Rule Name Data Type Description 3 Set Configuration DWORD Bit Value Control 1 3 Startup configuration 0 Use configuration saved in NVS 1 Obtain configuration via BOOTP 2 Obtain configuration via DHCP 3 to 15 Reserved 4 DNS Enabled Resolves host names by query to DNS server 5 to 31 Reserved 4 Get Physical Link STRUCT of Object UINT Path size Padded EPATH Path 5 Get Interface STRUCT of Configuration UDINT Adapter s IP address UDINT Adapter s subnet mask UDINT Adapter s gateway address UDINT Primary name server UDINT Secondary name server STRING Default domain name 6 Get Host Name STRING Host name when using DHCP Services Implemented for Service Code Class Instance Service Name Ox0E Yes Yes Get_Attribute_Single 0x10 No Yes Set_Attribute_Single C 34 EtherNet IP Objects Ethernet Link Object Class Code Hexadecimal Decimal OxF6 246
27. oup UINT 1 version 2 Get Max Instance UINT Total number of groups 8 Set Native USINT 0 English Language 1 French 2 Spanish Mexican 3 Italian 4 German 5 Japanese 6 Portuguese 7 Mandarin Chinese 8 Russian 9 Dutch C 14 EtherNet IP Objects Parameter Group Object Continued Instance Attributes Attribute Access ID Rule Name Data Type Description 1 Get Group Name String SHORT Group name STRING 2 Get Number of Members UINT Number of parameters in in Group group 3 Get 1st Parameter Number UINT 1 in Group 4 Get 2nd Parameter UINT 1 Number in Group n Get UINT 1 Value varies based on group instance Services Implemented for Service Code Class Instance Service Name Ox0E Yes Yes Get_Attribute_Single 0x01 Yes Yes Get Attributes All EtherNet IP Objects C 15 PCCC Object Class Code Hexadecimal Decimal 0x67 103 Instances Supports Instance 1 Class Attributes Not supported Instance Attributes Not supported Services Implemented for Service Code Class Instance Service Name 0x4B No Yes Execute_PCCC 0x4C No Yes Execute_DH Message Structure for Execute_PCCC Requst Response Data Data Name Type Description Name Type Description Length USINT Length of Length USINT Length of requestor ID requestor ID Vendor UINT Vendor number of Vendor UINT Vendor number of requestor requestor Serial
28. s C 26 C 27 CONTAINER Value CONTAINER Minimum value CONTAINER Maximum value CONTAINER _ Default value WORD Pad Word WORD Pad Word STRING 4 Units e g Amp Hz UINT Multiplier 9 UINT Divisor UINT Base INT Offset DWORD Link source of the value 0 no link STRING 16 Always zero 0 Parameter name 1 Get Set Value Various Diagnostic item value 1 A CONTAINER is a 32 bit block of data that contains the data type used by a value If signed the value is sign extended Padding is used in the CONTAINER to ensure that it is always 32 hits 2 This value is used in the formulas used to convert the value between display units and internal units Refer to Formulas for Converting on page C 27 Services Implemented for Service Code Class Instance Service Name Ox0E Yes Yes Get_Attribute_Single 0x10 Yes Yes Set_Attribute_Single C 32 EtherNet IP Objects TCP IP Interface Object Class Code Hexadecimal Decimal OxF5 245 Instances The adapter supports one instance of the TCP IP Interface object Number Description 0 Class Attributes 1 Object Attributes Class Attributes Attribute Access ID Rule Data Type Description 1 UINT The revision of this object Instance Attributes Attribute Access ID Rule Name Data Type Description 1 Get Status of TCP DWORD 0 Not configured IP Network 1 Valid configuration Interface 2 to 15 Reserved 2 Get Co
29. sage For details about Block Transfer messages and the data required for each byte in the N File refer to the Remote I O Adapter User Manual Publication 20COMM UMO004 Bits 15 to 8 are the Most Significant Byte Bits 7 to 0 are the Least Significant Byte Write Read Bits 15 0 15 0 N40 0 0x00 Length in Bytes 0x00 Length in Bytes N40 1 DPI Port 0x81 Status Size Status Type N40 2 0x00 CIP Service Data N40 3 CIP Class length varies based on message N40 4 CIP Instance N40 5 CIP Attribute N40 6 Data length varies based on message N40 63 1 Use the following DPI Port Assignment table to determine the value for the DPI port C 18 EtherNet IP Objects PCCC Object Continued N Files Continued DPI Port Assignments DPI Port No Single Drive Mode Multi Drive Mode 0 The drive Drive 0 1 The adapter Drive 1 2 The slave Drive 2 3 Not supported Drive 3 4 Not supported Drive 4 5 Not supported The adapter N File Description For Single Drive Mode Only N41 This N file lets you read and write control I O messages You can write control I O messages only when all of the following conditions are true e The adapter is not receiving I O from a scanner For example there is no scanner on the network the scanner is in idle program mode the scanner is faulted or the adapter is not mapped to the scanner e The value of N42 3 is set to a non zero value Write Read N
30. served 17 Extended 001 DWORD used as an array of Boolean Data Type Bit 2 010 Reserved 18 Extended i E iode Data Type Bit 2 evel Ve 101 Reserved 110 Reserved 111 Reserved EtherNet IP Objects C 27 DPI Parameter Object Continued Descriptor Attributes Continued Bit Name Description 19 Parameter Exists Reserved 20 Not Used Reserved 21 Formula Links Reserved 22 Access Level Bit 1 Reserved 23 Access Level Bit 2 Reserved 24 Access Level Bit 3 Reserved 25 Writable ENUM Reserved 26 Not a Link Source 0 Parameter can be a source for a link 1 Parameter cannot be a source for a link 27 Enhanced Bit ENUM Reserved 28 Enhanced ENUM Reserved 29 Not Used Reserved 30 Not Used Reserved 31 Not Used Reserved Formulas for Converting Display Value Internal Value Offset x Multiplier x Base Divisor x 10 Decima Places Internal Value Display Value x Divisor x 10 Decima Places Multiplier x Base Offset Common Services Implemented for Service Code Class Instance Service Name Ox0E Yes Yes Get_Attribute_Single 0x10 Yes Yes Set_Attribute_Single Object Specific Services Service Code Service Name 0x32 Get_Attributes_Scattered 0x34 Set_Attributes_Scattered 1 1 The instance and attribute are ignored for these services The table below lists the parameters for the Get_Attributes_Scattered and Set_At
31. t 2 Get Number of WORD Maximum number of faults events that the Instances device can record in its queue 3 Set Fault Command BYTE 0 No Operation Write 1 Clear Fault Event 2 Clear Fault Event Queue 3 Reset Device 4 Get Fault Trip WORD Fault that tripped the device For adapters Instance Read this value is always 1 when faulted 5 Get Fault Data List STRUCT of Reserved BYTE BYTE WORD n 6 Get Number of WORD Number of faults events in the queue A Recorded Faults 0 indicates the fault queue is empty 7 Get Fault Parameter WORD Reserved Reference DPI Fault Object Continued EtherNet IP Objects C 29 Instance Attributes Attribute Access ID Rule Name Data Type Description 0 Get Full All STRUCT of Information WORD Fault code STRUCT of Fault source BYTE DPI port BYTE DPI Device Object STRING 16 Fault text STRUCT of Fault time stamp LWORD Timer value 0 Timer not supported BOOL 16 BOOL O 0 invalid data 1 valid data BOOL 1 0 elapsed time 1 real time BOOL 2 15 Not used WORD Reserved CONTAINER n Reserved 1 Get Basic STRUCT of Information WORD Fault code STRUCT of Fault source BYTE DPI port BYTE DPI Device Object STRUCT of Fault time stamp LWORD Timer value 0 Timer not supported BOOL 16 BOOL O 0 invalid data 1 valid data BOOL 1 0 elapsed time 1 real time BOOL 2 15 Not used Services Implemented for Service Code C
32. te STS USINT 0 STS USINT Status byte TNSW UINT Transport word TNSW UINT Transport word Same value as the request FNC USINT Function code not EXT STS USINT Extended Status used for all CMD s not used for all CMD s PCCC ARRAY of CMD FNC specific PCCC ARRAY of CMD FNC specific params USINT parameters results USINT _ result data EtherNet IP Objects C 17 PCCC Object Continued The adapter supports the following PCCC command types CMD FNC Description 0x06 Ox03 Identify host and some status OxOF 0x67 PLC 5 typed write Ox0F 0x68 PLC 5typed read Ox0F 0x95 Encapsulate other protocol Ox0F 0xA2 SLC 500 protected typed read with 3 address fields OxOF 0xAA SLC 500 protected typed write with 3 address fields OxOF 0xA1 SLC 500 protected typed read with 2 address fields Ox0F 0xA9 SLC 500 protected typed write with 2 address fields OxOF 0x00 Word range read OxOF 0x01 Word range write See DF1 Protocol and Command Set Manual Allen Bradley Publication No 1770 6 5 16 N Files N File Description N40 This N file lets you use Emulated Block Transfer messages to read and write many types of DPI messages To use Emulated Block Transfer messages you send a Write message to N40 0 N40 63 wait until the adapter responds with a reply message and then read the response data in N40 0 N40 63 with a Read mes
33. tributes_Scattered object specific service Name Data Type Description Scattered Parameters STRUCT of Parameter Number WORD Parameter to read or write Parameter Value WORD Parameter value to read or write zero when reading Important The STRUCT may repeat up to 64 times in a single message C 28 EtherNet IP Objects DPI Fault Object Class Code Hexadecimal Decimal 0x97 151 Products such as PowerFlex drives use this object for faults Adapters use this object for events Instances The number of instances depends on the maximum number of faults or events supported in the queue The maximum number of faults events can be read in Instance 0 Attribute 2 Instances Dec 0 16383 Single Drive Mode Instances 0 16383 in the drive Multi Drive Mode Instances 0 16383 in Drive 0 16384 17407 Instances 0 1023 in the adapter Instances 0 1023 in the adapter 17408 18431 Instances 0 1023 in the adapter Instances 0 1023 in Drive 1 18432 19455 Instances 0 1023 in the slave Instances 0 1023 in Drive 2 19456 20479 Not supported Instances 0 1023 in Drive 3 20480 21503 Not supported Instances 0 1023 in Drive 4 21504 22527 _ Not supported Instances 0 1023 in the adapter Class Attributes Attribute Access ID Rule Name Data Type Description 1 Get Class Revision WORD Revision of objec
34. ulas for Converting on page C 27 9 Do NOT continually write parameter data to NVS Refer to the attention on page 6 1 C 26 EtherNet IP Objects DPI Parameter Object Continued Descriptor Attributes Bit Name Description 0 Data Type Bit 1 Right bit is least significant bit 0 000 BYTE used as an array of Boolean 001 WORD used as an array of Boolean 1 Data Type Bit 2 010 BYTE 8 bit integer 011 WORD 16 bit integer n 100 DWORD 32 bit integer Data Type eta 101 TCHAR 8 bit not unicode or 16 bits unicode 110 REAL 32 bit floating point value 111 Use bits 16 17 18 3 Sign Type 0 unsigned 1 signed 4 Hidden 0 visible 1 hidden 5 Not a Link Sink 0 Parameter can sink a link 1 Parameter cannot sink a link 6 Not Recallable 0 Recallable from NVS 1 Not Recallable from NVS 7 ENUM 0 No ENUM text 1 ENUM text 8 Writable 0 Read only 1 Read write 9 Not Writable When 0 Writable when enabled e g drive running Enabled 1 Not writable when enabled 10 Instance 0 Parameter value is not a Reference to another parameter 1 Parameter value refers to another parameter 11 Reserved Must be zero 12 Decimal Place Bit 0 Number of digits to the right of the decimal point 13 Decimal Place Bit 000070 14 Decimal Place Bit 2 i 15 Decimal Place Bit 3 16 Extended Right bit is least significant bit 16 Data Type Bit 1 000 Re
35. ultiplier UINT 3 14 Get Scaling Divisor UINT 8 15 Get Scaling Base UINT 8 16 Get Scaling Offset UINT 3 17 Get Multiplier Link UINT 3 18 Get Divisor Link UINT 3 19 Get Base Link UINT 3 20 Get Offset Link UINT 3 21 Get Decimal Precision USINT 3 Access rule is defined in bit 4 of instance attribute 4 0 Get Set 1 Get Specified in descriptor data type and data size Value varies based on parameter instance Refer to the CIP Common specification for a description of the link path C 12 EtherNet IP Objects Parameter Object Continued Services Implemented for Service Code Class Instance Service Name 0x01 Yes Yes Get_Attribute_All 0x05 Yes No Reset Ox0E Yes Yes Get_Attribute_Single 0x10 No Yes Set_Attribute_Single 0x4B No Yes Get_Enum_String Parameter Group Object Class Code Hexadecimal Decimal 0x10 16 Instances EtherNet IP Objects C 13 The number of instances depends on the number of groups in the device A group of adapter parameters is appended to the list of groups in the device The total number of groups can be read in Instance 0 Attribute 2 Number Description 0 Class Attributes 1 Drive Group 1 Attributes n Drive Group n Attributes 1 n 1 Adapter Group Attributes 1 n represents the number of parameter groups in the drive Class Attributes Attribute Access Data ID Rule Name Type Description 1 Get Parameter gr
36. y service data to be sent from the scanner or bridge to the adapter and drive Source Length This box contains the number of bytes of service data to be sent in the message Destination This box contains the name of the tag that will receive service response data from the adapter and drive 9 Path The path is the route that the message will follow Tip Click Browse to find the path or type in the name of an adapter that you previously mapped Name The name for the message 6 4 Using Explicit Messaging Performing Explicit Messages There are five basic events in the Explicit Messaging process The details of each step will vary depending on the controller Refer to the documentation for your controller Figure 6 2 Explicit Message Process o Complete Explicit o Retreive Explicit 9 Set up and send Explicit Message Request Message L Message Respnse Event 1 You format the required data and set up the ladder logic program to send an Explicit Message request to the scanner or bridge module download The scanner or bridge module transmits the Explicit Message Request to the slave device over the Ethernet network The slave device transmits the Explicit Message Response back to the scanner The data is stored in the scanner buffer The controller retrieves the Explicit Message Response from the scanner
37. z UINT Multiplier 2 UINT Divisor UINT Base INT Offset BYTE 3 Link source of the value 0 no link BYTE Always zero 0 STRING 16 Parameter name 8 Get DPI Descriptor BOOL 32 Descriptor Refer to pages C 26 C 27 9 Get Set DPI Parameter Various Parameter value in NVS 9 Value 10 Get Set DPI RAM Various Parameter value in temporary memory Parameter Value 11 Get Set DPI Link BYTE 3 Link parameter or function block that is the source of the value 0 no link 12 Get Help Object WORD D for help text for this parameter Instance 13 Get DPI Read Basic STRUCT of BOOL 32 Descriptor Refer to pages C 26 C 27 CONTAINER Parameter value CONTAINER Minimum value CONTAINER Maximum value CONTAINER Default value STRING 16 Parameter name STRING 4 Units e g Amp Hz 14 Get DPI Parameter STRING 16 Parameter name Name 15 Get DPI Parameter STRING 16 Customer supplied parameter name Alias Only supported by PowerFlex 700S at time of publication 16 Get Parameter BYTE 0 No error Processing Error 1 Value is less than the minimum 2 Value is greater than the maximum 1 A CONTAINER is a 32 bit block of data that contains the data type used by a parameter value If signed the value is sign extended Padding is used in the CONTAINER to ensure that it is always 32 bits 2 This value is used in the formulas used to convert the parameter value between display units and internal units Refer to Form
Download Pdf Manuals
Related Search