Home
/
Anybus
/
CompactCom 40 EtherNet/IP
/
Network Manual

Anybus CompactCom 40 EtherNet/IP, Network Manual

Share

Page: 114 / 198

Anybus CompactCom 40 EtherNet/IP Network Manual Download Page 114

114

Doc.Id. HMSI-27-212

Anybus CompactCom 40 EtherNet/IP
Doc.Rev. 1.5

Command Details: Shutdown

Category

Extended

Details

Command Code.:

11h

Valid for:

Instance

Description

This command closes a TCP-connection using the FIN-flag. Note that the response does not indicate
if the connection actually shut down, which means that this command cannot be used to poll non-block-
ing sockets, nor will it block for blocking sockets.

• Command Details

• Response Details

(no data)

The recommended sequence, performed by the application, to gracefully shut down a TCP connection
is described below.

Application initiates shutdown:

1.

Send shutdown with CmdExt[1] set to 01h. This will send FIN-flag to host shutting down the

send channel, note that the receive channel will still be operational.

2.

Receive data on socket until error message Object specific error (EDESTADDRREQ (14)) is

received, indicating that the host closed the receive channel. If host does not close the receive chan-
nel use a timeout and progress to step 3.

3.

Delete the socket instance. If step 2 timed out, RST-flag will be sent to terminate the socket.

A remote host initiates shutdown:

1.

Receive data on socket, if zero bytes received it indicates that the host closed the receive channel

of the socket.

2.

Try to send any unsent data to the host.

3.

Send shutdown with CmdExt[1] set to 01h. This will send FIN-flag to host shutting down the

receive channel.

4.

Delete the socket instance.

Field

Contents

CmdExt[0] (reserved, set to zero)
CmdExt[1] Value:Mode:

00h Shutdown receive channel
01h Shutdown send channel
02h Shutdown both receive- and send channel

«
...
112
113
114
115
116
...
»

Summary of Contents for CompactCom 40 EtherNet/IP

Page 1: ...dustrial Networks Mailing address Box 4126 300 04 Halmstad Sweden Visiting address Stationsgatan 37 Halmstad Sweden Connecting DevicesTM E mail info hms networks com Web www anybus com Network Guide Anybus CompactCom 40 EtherNet IP Doc Id HMSI 27 212 Rev 1 5 ...

Page 2: ...the applications meet all performance and safety requirements in cluding any applicable laws regulations codes and standards HMS Industrial Networks AB will under no circumstances assume liability or responsibility for any problems that may arise as a result from the use of undocumented features timing or functional side effects found outside the documented scope of this product The effects caused...

Page 3: ...e Customization 13 Network Identity 13 Electronic Data Sheet EDS 13 EtherNet IP CIP Implementation 14 Web Interface 14 Socket Interface Advanced Users Only 14 Modular Device Functionality 15 QuickConnect 15 CIP Safety 15 Communication Settings 16 Communication Settings in Stand Alone Shift Register Mode 17 Diagnostics 18 Network Data Exchange 19 Application Data 19 Process Data 19 Translation of D...

Page 4: ...efault Content Types 30 Authorization 30 Chapter 5 E mail Client General Information 32 How to Send E mail Messages 32 Chapter 6 Server Side Include SSI General Information 33 Include File 33 Command Functions 34 General Information 34 GetConfigItem 35 SetConfigItem 36 SsiOutput 38 DisplayRemoteUser 38 ChangeLanguage 39 IncludeFile 40 SaveDataToFile 41 printf 42 scanf 44 Argument Functions 46 Gene...

Page 5: ...ral Information 61 Translation of Status Codes 62 Identity Object 01h 63 Message Router 02h 66 Assembly Object 04h 67 Connection Manager 06h 70 Parameter Object 0Fh 74 DLR Object 47h 77 QoS Object 48h 78 Base Energy Object 4Eh 79 Power Management Object 53h 81 ADI Object A2h 83 Port Object F4h 85 TCP IP Interface Object F5h 87 Ethernet Link Object F6h 90 ...

Page 6: ...ation Object 0Dh 153 Chapter 10 Host Application Objects General Information 155 Functional Safety Host Object E8h 156 CIP Identity Host Object EDh 158 Sync Object EEh 160 EtherNet IP Host Object F8h 161 Ethernet Host Object F9h 171 Application File System Interface Object EAh 174 Appendix A Categorization of Functionality Basic 187 Extended 187 Appendix B Implementation Details SUP Bit Definition...

Page 7: ...w 193 Protective Earth PE Requirements 194 Power Supply 194 Environmental Specification 194 EMC Compliance 194 Appendix F Timing Performance General Information 195 Internal Timing 195 Startup Delay 195 NW_INIT Handling 195 Event Based WrMsg Busy Time 196 Event Based Process Data Delay 196 Appendix G Copyright Notice ...

Page 8: ...mon and 2 EtherNet IP ODVA Change Page s Added information about safety to feature section 10 Added CIP Safety section to Basic Operation chapter 15 Added Class 0 Connection details to the Connection Manager 06h 71 Added Functional Safety Module Object 11h 149 Added Functional Safety Host Object E8h 156 Revision Date Author s Chapter s Description 1 00 2014 06 04 KeL All First official revision 1 ...

Page 9: ...ompactCom 40 module The terms host or host application refers to the device that hosts the Anybus module Hexadecimal values are either written in the format NNNNh or the format 0xNNNN where NNNN is the hexadecimal value P 4 Abbreviations P 5 Support For general contact information and where to find support please refer to the contact and sup port pages at www anybus com Abbreviation Meaning API as...

Page 10: ...ompactCom 40 modules defined in the Anybus CompactCom 40 Hardware and Software Design Guides making it fully interchangeable with any other device following that specification Generally no additional network related software support is needed however in order to be able to take full advantage of advanced network specific func tionality a certain degree of dedicated software support may be necessar...

Page 11: ...upervisor and a number of ring nodes and use beacons to detect breaks in the ring When a DLR network detects a break in the ring it provides ways to alter natively route the data to recover the network Diagnostics built into DLR products can identify the point of failure thus helping to speed maintenance and reduce repair time The Anybus CompactCom 40 EtherNet IP implements the DLR protocol and it...

Page 12: ...ic re quests i e requests towards instances in the Application Data Object however it is generally recommended to process and respond to such requests within a reasonable time period The ap plication that sends the request also decides the timeout e g EIPScan employs a timeout of 10 seconds The use of advanced CIP specific functionality may require in depth knowledge in CIP network ing internals a...

Page 13: ...equires no deviations from the standard EDS file To obtain a Vendor ID contact the ODVA 2 2 2 Electronic Data Sheet EDS On EtherNet IP the characteristics of a device is stored in an ASCII data file with the suffix EDS This file is used by configuration tools etc when setting up the network configuration HMS supplies a stand ard generic EDS file which corresponds to the default settings in the mod...

Page 14: ...on in the EtherNet IP Host Object Implement the required CIP objects in the host application See also EtherNet IP Host Object F8h on page 161 Host Application Object Command Details Process_CIP_Object_Request on page 166 2 2 4 Web Interface The web interface can be fully customized to suit a particular application Dynamic content can be cre ated by means of JSON and SSI scripting Data and web page...

Page 15: ...ost Object The module fulfills Class A with a startup time of less than 180 ms with 16 bytes of I O data mapped with parallel SPI or shift register application interface See also EtherNet IP Host Object F8h on page 161 TCP IP Interface Object F5h on page 87 CIP object 2 2 8 CIP Safety The Anybus CompactCom 40 EtherNet IP device supports the CIP safety profile This profile makes it possible for a u...

Page 16: ...rom a DHCP server automatically DHCP is enabled by default but can be disabled if necessary Physical Link Settings By default the module uses auto negotiation to establish the physical link settings however it is possible to force a specific setting if necessary The parameters in the Network Configuration Object 04h are available from the network through the built in web server and through the TCP...

Page 17: ...nfiguration Object 04h on page 99 Start DIP1 switch settings 0 255 255 0 1 254 Values stored in Network Configuration Object instances 3 6 will be used Ethernet Host Object F9h attribute 17 implemented Yes No Use default value for IP address bytes 0 2 192 168 0 X Use DIP switch settings for IP address byte 3 End Use attribute 17 values for IP address bytes 0 2 IP address is stored in Network Confi...

Page 18: ...v 1 5 2 4 Diagnostics The severity value of all pending events are combined using logical OR and copied to the correspond ing bits in the Status attribute of the Identity Object CIP See also Identity Object 01h on page 63 CIP Diagnostic Object 02h on page 97 Anybus Module Object ...

Page 19: ...ta Type CIP Data Type Comments BOOL BOOL Each ADI element of this type occupies one byte ENUM USINT SINT8 SINT UINT8 USINT SINT16 INT Each ADI element of this type occupies two bytes UINT16 UINT SINT32 DINT Each ADI element of this type occupies four bytes UINT32 UDINT FLOAT REAL CHAR SHORT_STRING SHORT_STRING consists of a single byte length field which in this case represents the number of ADI e...

Page 20: ...y provides access to the application file system through the Applica tion File System Interface Object EAh optional Firmware Firmware updates are stored in this directory Important In the firmware folder it is not possible to use append mode when writing a file Be sure to use write mode only Anybus CompactCom File system File 1 File 2 VFS File 1 File 2 Application Application File system File A1 F...

Page 21: ...rver Side Include SSI on page 33 Anybus File System Interface Object 0Ah on page 131 Application File System Interface Object EAh on page 174 IMPORTANT The file system is located in flash memory Due to technical reasons each flash segment can be erased approximately 100000 times before failure making it unsuitable for random access storage The following operations will erase one or more flash segm...

Page 22: ...ctory for all users Users are not able to access files outside of their home directory File Format User1 Password1 Homedirectory1 User2 Password2 Homedirectory2 User3 Password3 Homedirectory3 Optionally the UserN PasswordN section can be replaced by a path to a file containing a list of users as follows File Format ftp cfg User1 Password1 Homedirectory1 User2 Password2 Homedirectory2 UserN Passwor...

Page 23: ...rec tory will be the system root 1 It is strongly recommended to have at least one user with root access permission If not Admin Mode must be enabled each time a system file needs to be altered including ftp cfg 3 3 Session Example The Windows Explorer features a built in FTP client which can easily be used to access the file system as follows 1 Open the Windows Explorer 2 In the address field typ...

Page 24: ...rovide access to Network configuration parameters Network status information Access to the host application ADIs The default web pages are built of files stored in a virtual file system accessible through the vfs folder These files are read only and cannot be deleted or overwritten The web server will first look for a file in the web root folder If not found it will look for the file in the vfs fo...

Page 25: ...configuration page provides an interface for changing TCP IP and SMTP settings in the Network Configuration Object The module needs to be reset for the TCP IP and SMTP settings to take effect The Ethernet Config uration settings will take effect immediately Available editable settings will be explained on the next page ...

Page 26: ...dress The TCP IP settings of the module Default values 0 0 0 0 Value ranges 0 0 0 0 255 255 255 255 Subnet mask Gateway Host name IP address or name Max 64 characters Domain name IP address or name Max 48 characters DNS 1 Primary and secondary DNS server used to resolve host name Default values 0 0 0 0 Value ranges 0 0 0 0 255 255 255 255 DNS 2 Name Description Port 1 Ethernet speed duplex setting...

Page 27: ... unicast packets In NUcast packets Received non unicast packets broadcast and multicast In Discards Received packets discarded due to no available memory buffers In Errors Received packets discarded due to reception error In Unknown Protos Received packets with unsupported protocol type Out Octets Sent bytes Out Ucast packets Sent unicast packets Out NUcast packets Sent non unicast packets broadca...

Page 28: ...rier sense condition was lost or never asserted when attempted to transmit a frame Frame Size Too Long Frames received that exceed the maximum permitted frame size Frame Size Too Short Frames received that are shorter than lowest permitted frame size a Not provided with current PHY interface Media Counters Description ...

Page 29: ...ages in the following order 1 WebRoot index htm 2 WebRoot index html 3 WebRoot index shtm 4 WebRoot index wml Note 1 Substitute WebRoot with the web root directory specified in http cfg Note 2 If no index page is found the module will default to the virtual index file if enabled See also Default Web Pages on page 24 File Format WebRoot web FileTypes FileType1 ContentType1 FileType2 ContentType2 Fi...

Page 30: ...s subdirectories File Extension Reported Content Type htm html shtm text html gif image gif jpeg jpg jpe image jpeg png image x png js application x javascript bat txt c h cpp hpp text plain zip application x zip compressed exe com application octet stream wml text vnd wap wml wmlc application vnd wap wmlc wbmp image vnd wap wbmp wmls text vnd wap wmlscript wmlsc application vnd wap wmlscriptc xml...

Page 31: ...d from the network Example In this example the list of approved users will be loaded from here cfg and too cfg File path i put some over here cfg i actually put some of it here too cfg AuthType Basic AuthName Howdy Password please The field AuthType is used to identify the authentication scheme Value Description Basic Web authentication method using plain text passwords Digest More secure method u...

Page 32: ...ject 04h on page 99 SMTP Client Object 09h on page 126 5 2 How to Send E mail Messages To be able to send e mail messages the SMTP account settings must be specified This includes A valid SMTP server address A valid user name A valid password To send an e mail message perform the following steps 1 Create a new e mail instance using the Create command 03h 2 Specify the sender recipient topic and me...

Page 33: ...sult specified operation if applicable By default only files with the extension shtm are scanned for SSI 6 2 Include File This function includes the contents of a file The content is scanned for SSI Note This function cannot be used in e mail messages Syntax include file filename filename Source file Default Output 1 JSON offers more functionality when it comes to web pages but is also more comple...

Page 34: ...nctions executes commands and includes the result General Syntax exec cmd_argument command command Command function see below Command Functions Command Valid for Email Messages Page GetConfigItem Yes 35 SetConfigItem No 36 SsiOutput Yes 38 DisplayRemoteUser No 38 ChangeLanguage No 39 IncludeFile Yes 40 SaveDataToFile No 41 printf Yes 42 scanf No 44 ...

Page 35: ...e key separator filename Source file to read from key Source key in file separator Optional specifies line separation characters e g br default is CRLF Default Output Example The following SSI exec cmd_argument GetConfigItem fruit cnf Lemon in combination with the following file fruit cnf Apple Green Lemon Yellow Banana Blue returns the string Yellow Scenario Default Output Success value of specif...

Page 36: ...o create a new file each time the command is issued The default behaviour is to modify the existing file File Format Each form object is stored as a tag followed by the actual value form object name 1 form object value 1 form object name 2 form object value 2 form object name 3 form object value 3 form object name N form object value N Note Form objects with names starting with underscore _ will n...

Page 37: ...PUT type text name Name BR BR LABEL for _Age Age LABEL BR INPUT type text name _Age BR BR LABEL for Food Food LABEL BR INPUT type radio name Food value Cheese Cheese BR INPUT type radio name Food value Sausage Sausage BR BR LABEL for Drink Drink LABEL BR INPUT type radio name Drink value Wine Wine BR INPUT type radio name Drink value Beer Beer BR BR INPUT type submit name _submit INPUT type reset ...

Page 38: ...e Default Output this command produces no output on its own Example The following example illustrates how to use this command exec cmd_argument SsiOutput Parameter stored Error exec cmd_argument SetConfigItem File cfg Overwrite See also SSI Output Configuration on page 50 6 3 5 DisplayRemoteUser This command stores returns the user name on an authentication session Note This command cannot be used...

Page 39: ...ample The following example demonstrates how to use this function The resulting page sends a form to itself which is then evaluated by the ChangeLanguage command HTML HEAD TITLE ChangeLanguage Test TITLE HEAD BODY exec cmd_argument ChangeLanguage lang FORM action test shtm P LABEL for lang Language 0 4 LABEL BR INPUT type text name lang BR BR INPUT type submit name _submit P FORM BODY HTML Note In...

Page 40: ...ut Example The following example demonstrates how to use this function HTML HEAD TITLE IncludeFile Test TITLE HEAD BODY H1 Contents of info txt H1 P exec cmd_argument IncludeFile info txt P BODY HTML Contents of info txt Neque porro quisquam est qui dolorem ipsum quia dolor sit amet consectetur adipisci velit When viewed in a browser the resulting page should look somewhat as follows See also Incl...

Page 41: ... whether to overwrite or append data to existing files Default Output Example The following example demonstrates how to use this function The resulting page sends a form to itself which is then evaluated by the SaveDataToFile command HTML HEAD TITLE SaveDataToFile Test TITLE HEAD BODY exec cmd_argument SaveDataToFile stuff txt Meat Overwrite FORM action test shtm P LABEL for Fruit Fruit LABEL BR I...

Page 42: ...e Get_Attribute on page 48 Scenario Default Output Success printf result ABCCMessage error ABCCMessage error string Errors on page 49 template Template which determines how the arguments shall be represented May contain any number of formatting tags which are substituted by subse quent arguments and formatted as requested The number of format tags must match the number of arguments if not the resu...

Page 43: ...ber does not start with a or prefix it with a space character instead 0 zero Pad the field with zeroes instead of spaces For e E and f forces the number to include a decimal point even if no digits follow For x and X prefixes 0x or 0X respectively Width Meaning number Specifies the minimum number of characters to be printed If the value to be printed is shorter than this number the result is padde...

Page 44: ... scanf source template argument1 argumentN Default Output Example See also ABCCMessage on page 46 Example Set_Attribute on page 48 Scenario Default Output Success Success Parsing error Incorrect data format Too much data for argument Too much data ABCC Message error ABCCMessage error string Errors on page 49 source Name of the HTML form object from which the string shall be extracted template Temp...

Page 45: ...l integer SINT8 UINT8 SINT16 UINT16 SINT32 UINT32 e E f g G Accepts an optionally signed floating point number The input format for float ing point numbers is a string of digits with some optional characteristics It can be a signed value It can be an exponential value containing a decimal rational number fol lowed by an exponent field which consists of an E or an e followed by an integer FLOAT n C...

Page 46: ...ommand Number ce0 Specifies CmdExt 0 for the command message ce1 Specifies CmdExt 1 for the command message msgdata Specifies the actual contents of the MsgData subfield in the command c_type Specifies the data type in the command msgdata r_type Specifies the data type in the response msgdata Numeric input can be supplied in the following formats Decimal e g 50 no prefix Octal e g 043 Prefix 0 zer...

Page 47: ... 16 bit field BITS32 Yes 32 bit field OCTET Yes 8 bit field BIT1 7 Yes 1 bit to 7 bit field PAD0 16 Yes 0 16 bit field for filling up a string to a predefined size NONE No Command holds no data hence no data type Type Supports Arrays Comments BOOL Yes Optionally it is possible to exchange the BOOL data with a message based on the value true or false In such case the actual data type returned from ...

Page 48: ... on page 42 Example Set_Attribute This example shows how to set the IP address using scanf and ABCCMessage Note the spe cial parameter value ARG which instructs the module to use the passed form data parsed by scanf exec cmd_argument scanf IP u u u u ABCCMessage 4 3 2 5 0 ARG UINT8 4 NONE See also scanf on page 44 PAD0 16 Yes NONE No Variable Value Comments object 4 Network Configuration Object 04...

Page 49: ...guration on page 50 Error Code Output 0 Unknown error 1 Unknown error 2 Invalid message format 3 Unsupported object 4 Unsupported instance 5 Unsupported command 6 Invalid CmdExt 0 7 Invalid CmdExt 1 8 Attribute access is not set able 9 Attribute access is not get able 10 Too much data in msg data field 11 Not enough data in msg data field 12 Out of range 13 Invalid state 14 Out of resources 15 Seg...

Page 50: ...glish 1 German 2 Spanish 3 Italian 4 French Each error code corresponds to a dedicated output string labelled from 1 to 16 See also Errors on page 49 Use s to include the name of the file Use s to include the name of the file Use s to include the name of the file ABCCMessage_X 0 Success string 1 Error string 1 2 Error string 2 16 Error string 16 GetConfigItem_X 0 Success string 1 Authentication er...

Page 51: ...create a web page is added at the end of this chapter Access The JSON resources should be password protected Add password protection by adding a file called web_accs cfg in the root directory See Authorization on page 30 for more information Error If the module fails to parse or process a request the response will contain an error object with an Anybus error code error 02 7 2 JSON Objects 7 2 1 AD...

Page 52: ...t count callback function This object call fetches metadata for up to count ADIs starting from offset in a list sorted by ADI order number This data is static during runtime Optionally a callback may be passed to the GET request for JSONP output JSON object layout instance 1 name Temperature threshold numelements 1 datatype 0 min 00 max FF access 0x03 nine more Name Data Type Note instance Number ...

Page 53: ...alue 2 update json POST adi update json form data inst instance value data elem element callback function Updates the value of an ADI for the specified ADI instance instance The value data shall be hex formatted see Hex Format Explained on page 59 for more information If element is spec ified only the value of the specified element is updated In this case data shall only update that single element...

Page 54: ...ET module info json JSON object layout modulename ABCC M40 serial ABCDEF00 fwver 1 5 0 uptime 5 123456 cpuload 55 Name Data Type Note modulename String serial String 32 bit hex ASCII fwver Array of Number major minor build uptime Array of Number high low milliseconds ms cpuload Number CPU load in ...

Page 55: ...ed Comm Object Definition JSON object layout mac 003011FF0201 comm1 link 1 speed 1 duplex 1 comm2 link 0 speed 0 duplex 0 Name Data Type Note mac String 6 byte hex comm1 Object See object definition in the table below comm2 Object See object definition in the table below Name Data Type Note link Number 0 No link 1 Link speed Number 0 10 Mbit 1 100 Mbit duplex Number 0 Half 1 Full ...

Page 56: ... hms se To change IP settings use network ipconf json It accepts any number of arguments from the list above Values should be in the same format Example GET ipconf json dhcp 0 addr 10 11 32 2 hostname abcc123 domainname hms se ethconf json GET network ethconf json comm2 is not present if Ethernet port 2 is inactivated The values of comm1 and comm2 comes from the Network Configuration object 04h in...

Page 57: ...the module Name Data Type Note inoctets Number IN bytes inucast Number IN unicast packets innucast Number IN broadcast and multicast packets indiscards Number IN discarded packets inerrors Number IN errors inunknown Number IN unsupported protocol type outoctets Number OUT bytes outucast Number OUT unicast packets outnucast Number OUT broadcast and multicast packets outdiscards Number OUT discarded...

Page 58: ...l number of octets in length fcs Number Frames received that do not pass the FCS check singlecoll Number Successfully transmitted frames which experienced exactly one collision multicoll Number Successfully transmitted frames which experienced more than one collision latecoll Number Number of collisions detected later than 512 bit times into the transmission of a packet excesscoll Number Frames fo...

Page 59: ...ax and min fields and the ADI values are ABP data encoded in a hex format If the data type is an integer the endianness used is determined by the data format field found in adi info json see info json on page 51 Examples The value 5 encoded as a UINT16 with data format 0 little endian 0500 The character array ABC encoded as CHAR 3 data format is not relevant for CHAR 414243 Name Data Type Note ser...

Page 60: ...The file containing this code has to be stored in the built in file system see File System on page 20 and the result can be seen in a common browser html head title Anybus CompactCom title Imported libs script type text javascript src vfs js jquery 1 9 1 js script script type text javascript src vfs js tmpl js script head body div id info content div script type text x tmpl id tmpl info b From inf...

Page 61: ...47h on page 77 QoS Object 48h on page 78 TCP IP Interface Object F5h on page 87 Ethernet Link Object F6h on page 90 CIP Energy Objects Base Energy Object 4Eh on page 79 Power Management Object 53h on page 81 Optional Objects Port Object F4h on page 85 Optional Vendor Specific Objects ADI Object A2h on page 83 It is possible to implement additional CIP objects in the host application using the CIP ...

Page 62: ...not supported 06h Invalid CmdExt 0 14h Depending on Anybus CompactCom Service return ing this reply e g attribute not supported 07h Invalid CmdExt 1 Depending on Anybus CompactCom Service return ing this reply 08h Attribute not settable 0Eh Attribute not settable 09h Attribute not gettable 2Ch Attribute not gettable 0Ah Too Much Data 15h Too much data 0Bh Not Enough Data 13h Not enough data 0Ch Ou...

Page 63: ...l instances describe different parts of the product e g the software If modular device functionality is enabled a list of the modules in the slots can be retrieved and made available to the network master by sending a get request to class attribute 100 Instance attributes 1 7 can be customized by implementing the EtherNet IP Host Object Additional identity instances can be registered by implementi...

Page 64: ...02Bh Generic Device a 3 Product Code Get UINT 0037h Anybus CompactCom 40 EtherNet IP a 4 Revision Get Struct of USINT USINT Major and minor firmware revisiona 5 Status Get WORD See Device Status on page 65 6 Serial Number Get UDINT Unique serial number assigned by HMS a 7 Product Name Get SHORT_STRING Anybus CompactCom 40 EtherNet IP TM a 11 Active language Set Struct of USINT USINT USINT Requests...

Page 65: ...a out of box configuration and performs a reset and corresponds to Anybus reset type 2 Power cycling factory default For further information consult the general Any bus CompactCom 40 Software Design Guide bit s Name 0 Module Owned 1 reserved 2 Configureda a This bit shows if the product has other settings than out of box The value is set to true if the configured attribute in the Application Objec...

Page 66: ...iption The Message Router Object provides a messaging connection point through which a client may address a service to any object class or instance residing in the physical module In the Anybus CompactCom 40 module it is used internally to direct object requests Supported Services Class Instance Class Attributes Instance Attributes ...

Page 67: ...nsume data from the network See also Process Data on page 19 EtherNet IP Host Object F8h on page 161 Assembly Mapping Object see Anybus CompactCom 40 Software Design Guide Supported Services Class Get_Attribute_Single Instance Get_Attribute_Single Set_Attribute_Single Class Attributes Instance 03h Attributes Heartbeat Input Only Extended This instance is used as heartbeat for Input Only connection...

Page 68: ... 06h Attributes Heartbeat Input Only Extended Extended This instance is used as heartbeat for input only extended connections and does not carry any attributes The state of connections made to this instance does not affect the state of the Anybus CompactCom 40 module i e if the connection times out the module does not switch to the Error state The data size of the Heartbeat instance in the Forward...

Page 69: ...The instance number for this instance can be changed by implementing the corresponding attribute in the EtherNet IP Host Object See also Network Data Exchange on page 19 EtherNet IP Host Object F8h on page 161 Instance attribute 7 Instance 96h Attributes Consuming Instance Extended The instance number for this instance can be changed by implementing the corresponding attribute in the EtherNet IP H...

Page 70: ...s received 2 Open Format Rejects Set UINT Number of Forward Open service requests which were rejected due to bad format 3 Open Resource Rejects Set UINT Number of Forward Open service requests which were rejected due to lack of resources 4 Open Other Rejects Set UINT Number of Forward Open service requests which were rejected for reasons other than bad format or lack of resources 5 Close Requests ...

Page 71: ...nections that shall only access inputs Class 1 connections use UDP transport Null forward open is supported Total number of supported class 0 connections 2 Max input connection size 241 bytesa a Including the Mode Byte Actual Complement and Time stamp sections Max output connection size 239 bytesa Supported RPIb b Requested packet interval 1 20000 ms Total number of supported class 1 connections 4...

Page 72: ...ection This connections functionality is the same as the standard Input Only connection However when this connection times out it does not affect the state of the application Connection point O T Assembly Object instance 06h Default Connection point T O Assembly Object instance 64h Default Listen Only connection This type of connection requires another connection in order to exist If that connecti...

Page 73: ...lish connections towards the message router Thereafter the connection is used for explicit messaging Class 3 connections use TCP transport No of simultaneous Class 3 connections 6 Supported RPI 100 10000 ms T O Connection type Point to point O T Connection type Point to point Supported trigger type Application Supported connection size 1448 bytes Supported priorities Low ...

Page 74: ...ndard ADIs containing multiple ele ments i e arrays etc cannot be represented through this object In such cases default values will be returned see Default Values on page 76 See also ADI Object A2h on page 83 CIP Object EtherNet IP Host Object F8h on page 161 Host Application Object Supported Services Class Get_Attribute_Single Instance Get_Attribute_Single Set_Attribute_Single Get_Attributes_All ...

Page 75: ...A 4 Read only Parameter 5 Monitor Parameter N A 6 Supports Extended Precision Scaling N A 5 Data Type Get USINT Data type code 6 Data Size Get USINT Number of bytes in parameter value 7 Parameter Name String Get SHORT_STRING Name of the parameter truncated to 16 chars 8 Units String Get SHORT_STRING default string 9 Help String Get SHORT_STRING 10 Minimum Value Get Data Type a a The Data Type is d...

Page 76: ... 2 Link Path Size 0 Size of link path in bytes 3 Link Path NULL Path 4 Descriptor 0010h Read only Parameter 5 Data type C6h USINT 6 Data size 1 7 Parameter Name String Reserved 8 Units String 9 Help String 10 Minimum value N A 0 11 Maximum value N A 0 12 Default value N A 0 13 Scaling Multiplier N A 1 14 Scaling Divisor N A 1 15 Scaling Base N A 1 16 Scaling Offset N A 0 17 Multiplier Link N A 0 1...

Page 77: ...utes_All Instance Get_Attribute_Single Class Attributes Instance Attributes Extended Name Access Type Value 1 Revision Get UINT 0003h Object revision Name Access Type Value 1 Network Topol ogy Get USINT Bit Contents 0 Linear 1 Ring 2 Network Status Get USINT Bit Contents 0 Normal N A 1 Ring Fault 2 Unexpected Loop Detected 3 Partial Network Fault 4 Rapid Fault Restore Cycle 10 Active Supervisor Ad...

Page 78: ...iffServ code points DSCP or sending EtherNet IP messages in 802 1Q tagged frames Supported Services Class Get_Attribute_Single Instance Get_Attribute_Single Set_Attribute_Single Class Attributes Instance Attributes Extended Name Access Type Value 1 Revision Get UINT 0001h Object revision Name Access Type Value 1 802 1Q Tag Enable Set USINT Enables or disables sending 802 1Q frames Bit Contents 0 D...

Page 79: ...c power monitor may count metering pulse output transitions of a separate metering device The count of such transitions represented by a Base Energy Object instance would reflect the energy consumption measured by the separate metering device An instance of the Base En ergy Object may exist as a stand alone instance or it may exist in conjunction with an Electrical and or Non Electrical Energy Obj...

Page 80: ...0 01 of other units specified in attribute 4 If 0 unknown 4 Energy Accu racy Basis Get UINT Always 0 Percent of reading 7a a Depending on whether the instance reports consumed or generated energy either attribute 7 or attribute 8 is required Consumed Energy Odome ter Get ODOMETERb b This struct data type makes it possible to represent very large values for more information please consult the CIP s...

Page 81: ...ngle Instance Get_Attribute_Single Power_Management Set_Pass_Code Clear_Pass_Code Class Attributes Instance Attributes Extended Name Access Type Value 1 Revision Get UINT 0002h Object revision Name Access Type Value Description 1 Power Manage ment Command Get DWORD Collection of bit fields comprising the most recent power manage ment request 2 Power Manage ment Status Get DWORD Collection of bit f...

Page 82: ...unit of Minimum Pause Time UINT Minimum Pause Time USINT Resume Units Specifies the unit of Resume Time UINT Resume Time Required time to transition from the paused stated to the owned state REAL Power Level Power in kW for this mode BOOL Availability Specifies whether this mode can be entered given the current device state 6 Sleeping State Support Get BOOL 0 Sleeping state not supported Name Acce...

Page 83: ...he EtherNet IP Host Object F8h This attribute can also be used to change the ADI Object number See also Application Data Object see Anybus CompactCom 40 Software Design Guide Parameter Object 0Fh on page 74 CIP Object EtherNet IP Host Object F8h on page 161 Supported Services Class Get_Attribute_Single Instance Get_Attribute_Single Set_Attribute_Single Class Attributes Name Access Type Value 1 Rev...

Page 84: ...stance value 3 No of Elements Get USINT Number of elements of the specified data type 4 Descriptor Get Array of USINT Bit field describing the access rights for this instance Bit Meaning 0 Set Get Access 1 Set Set Access 5 Valuea a Converted to from CIP standard by the module Get Set Determined by attribute 2 Instance value 6 Max Valuea Get The maximum permitted parameter value 7 Min Valuea Get Th...

Page 85: ..._All Get_Attribute_Single Instance Get_Attributes_All Get_Attribute_Single Class Attributes Name Access Type Value 1 Revision Get UINT Object revision Current value 0001h 2 Max Instance Get UINT Max instance number 3 Number of Instances Get UINT Number of ports currently created 8 Entry Port Get UINT Returns the instance of the Port Object that describes the port through which this request entered...

Page 86: ...Get SHORT_STRING 6 Port Description Get SHORT_STRING 7 Node Address Get Padded EPATH Name Access Type Value 1 Port Type Get UINT Enumerates the type of port 2 Port Number Get UINT CIP port number associated with this port 3 Link Object Get Struct of UINT Padded EPATH Path length number of 16 bit words Logical path segments which identify the object for this port The path must consist of one logica...

Page 87: ...on Object 04h on page 99 Anybus Module Object Supported Services Class services Get_Attribute_All Get_Attribute_Single Instance services Get_Attribute_All Get_Attribute_Single Set_Attribute_Single Class Attributes Name Access Type Value 1 Revision Get UINT 0004h Object revision 2 Max instance Get UINT 1 Maximum instance number 3 Number of instances Get UINT 1 Number of instances 6 Maximum ID Numbe...

Page 88: ...n Settable bit reflects the value of instance attribute 9 in the Ether Net IP Host Object F8h on page 161 The module is hardware configurable when this bit is set to 1 The bit will be set if any of the address attributes is set in the Network Configuration Object 04h during setup or if attribute 6 Hardware configu rable address in the Application Object FFh is set Always 0 For more information con...

Page 89: ...ote node form the ARP PDU in which a conflict was detected ArpPdu ARRAY of 28 USINT Copy of the raw ARP PDU in which a con flict was detected 12 EIP QuickCon nectc d Set Bool 0 Value 0 1 Meaning Disable EIP QuickConnect Default Enable EIP QuickConnect If EIP QuickConnect is enabled the Quick Connect feature will direct EtherNet IP tar get devices to quickly power up and join an EtherNet IP network...

Page 90: ...ribute_Single Instance services Get_Attribute_All Get_Attribute_Single Set_Attribute_Single Get_And_Clear Class Attributes By default three instances port 1 port 2 and the internal port are implemented meaning that two ports are activated If port 2 is inactivated in the Port 2 State attribute of the Ethernet Host Object F9h only one instance port 1 should be implemented Name Access Type Value 1 Re...

Page 91: ...ers Struct of Media specific counters Alignment Errors UDINT N A Frames received that are not an integral num ber of octets in length FCS Errors UDINT N A Frames received that do not pass the FCS check Single Collisions UDINT N A Successfully transmitted frames that have experienced exactly one collision Multiple Collisions UDINT N A Successfully transmitted frames that have experienced more than ...

Page 92: ...attribute can be disabled by implementing attribute 9 in the EtherNet IP Host Object F8h b Support for this attribute can be disabled by implementing the port state attributes 12 or 13 in the Ethernet Host object F9h Bit Name Description 0 Link status Indicates whether or not the Ethernet 802 3 communications interface is con nected to an active network Value Meaning 0 Inactive link 1 Active link ...

Page 93: ... the interface state Interface Label Interface Type Value Description 0 Unknown interface state 1 The interface is enabled and is ready to send and receive data 2 The interface is disabled 3 The interface is testing Value Description 0 reserved 1 Enable the interface 2 Disable the interface 3 255 reserved Instance Value 1 Port 1 2 Port 2 3 Internal Instance Value Description 1 2 Twisted pair 2 2 T...

Page 94: ... effect Note this bit shall also be replicated in the Interface Flags attribute 2 in order to retain backwards compatibility with previous object revisions Return 0 1 Auto negotiate 0 Indicates that the interface does not support link auto negotiation 1 Indicates that the interface supports link auto negotiation 0 for internal interface 1 for external interfaces 2 Auto MDIX 0 Indicates that the in...

Page 95: ...om 40 EtherNet IP Standard Objects Anybus Object 01h on page 96 Diagnostic Object 02h on page 97 Network Object 03h on page 98 Network Configuration Object 04h on page 99 Network Specific Objects Socket Interface Object 07h on page 109 SMTP Client Object 09h on page 126 Anybus File System Interface Object 0Ah on page 131 Network Ethernet Object 0Ch on page 19 CIP Port Configuration Object 0Dh on p...

Page 96: ...on Instance Attributes Instance 1 Basic Extended Name Access Type Value 1 Module type Get UINT16 0403h Standard Anybus 40 CompactCom 2 11 Consult the general Anybus CompactCom 40 Software Design Guide for further information 12 LED colours Get struct of UINT8 LED1A UINT8 LED1B UINT8 LED2A UINT8 LED2B Value Colour 01h Green 02h Red 01h Green 02h Red 13 16 Consult the general Anybus CompactCom 40 So...

Page 97: ...e also Diagnostics on page 18 Identity Object 01h on page 63 CIP object Name Access Data Type Value 1 4 Consult the general Anybus CompactCom 40 Software Design Guide for further information 11 Max no of instances Get UINT16 5 1 One instance is reserved for major diagnostic events 12 Supported functionality Get BITS32 00 00 00 00h Latching events are not supported Name Access Type Value 1 Severity...

Page 98: ...tributes Instance 1 Basic Name Access Type Value 1 Network type Get UINT16 009Bh 2 Network type string Get Array of CHAR Ethernet IP TM 3 Data format Get ENUM 00h LSB first 4 Parameter data support Get BOOL True 5 Write process data size Get UINT16 Current write process data size in bytes Updated on every successful Map_ADI_Write_Areaa a Consult the general Anybus CompactCom 40 Software Design Gui...

Page 99: ...Module Status LED will flash red to indicate a minor error The object is described in further detail in the Anybus CompactCom 40 Software Design Guide See also Communication Settings on page 16 TCP IP Interface Object F5h on page 87 CIP object Ethernet Link Object F6h on page 90 CIP object E mail Client on page 32 Supported Commands Object Get_Attribute Reset Instance Get_Attribute Set_Attribute G...

Page 100: ...ilingual Strings on page 107 Get Array of CHAR Subnet mask 2 Data type Get UINT8 04h UINT8 3 Number of elements Get UINT8 04h four elements 4 Descriptor Get UINT8 07h read write shared access 5 Value Get Set Array of UINT8 Any change is valid after reset Valid range 0 0 0 0 255 255 255 255 Default 0 0 0 0 6 Configured Value Get Array of UINT8 Holds the configured value which will be written to att...

Page 101: ...l be written to attribute 5 after the module has been reset Value Enum String Meaning 00h Disable DHCP disabled 01h Enable DHCP enabled default Name Access Type Description 1 Namea a Multilingual see Multilingual Strings on page 107 Get Array of CHAR Comm 1 2 Data type Get UINT8 08h ENUM 3 Number of elements Get UINT8 01h one element 4 Descriptor Get UINT8 07h read write shared access 5 Valuea Get...

Page 102: ...100 HDX 100Mbit half duplex 04h 100 FDX 100Mbit full duplex 6 Configured Value Get ENUM Holds the configured value which will be written to attribute 5 Value Enum String Meaning 00h Auto Auto negotiation default 01h 10 HDX 10Mbit half duplex 02h 10 FDX 10Mbit full duplex 03h 100 HDX 100Mbit half duplex 04h 100 FDX 100Mbit full duplex Name Access Type Description 1 Namea a Multilingual see Multilin...

Page 103: ...ange is valid after reset Valid range 0 0 0 0 255 255 255 255 Default 0 0 0 0 6 Configured Value Get Array of UINT8 Holds the configured value which will be written to attribute 5 after the module has been reset Valid range 0 0 0 0 255 255 255 255 Default 0 0 0 0 Name Access Type Description 1 Namea a Multilingual see Multilingual Strings on page 107 Get Array of CHAR Host name 2 Data type Get UIN...

Page 104: ...HAR Any change is valid after reset Domain name 48 characters 6 Configured Value Get Array of CHAR Holds the configured value which will be written to attribute 5 after the module has been reset Host name 48 characters Name Access Type Description 1 Namea a Multilingual see Multilingual Strings on page 107 Get Array of CHAR SMTP Server 2 Data type Get UINT8 04h UINT8 3 Number of elements Get UINT8...

Page 105: ...Set Array of CHAR Any change is valid after reset SMTP account user name 64 characters 6 Configured Value Get Array of CHAR Holds the configured value which will be written to attribute 5 after the module has been reset SMTP account user name 64 characters Name Access Type Description 1 Namea a Multilingual see Multilingual Strings on page 107 Get Array of CHAR SMTP Pswd 2 Data type Get UINT8 07h ...

Page 106: ...ber of elements Get UINT8 01h 4 Descriptor Get UINT8 07h read write shared access 5 Value Get Set ENUM Value Enum String Meaning 00h Auto default 01h MDI 02h MDIX 6 Configured Value Get ENUM Holds the configured value which will be written to attribute 5 Value Enum String Meaning 00h Auto default 01h MDI 02h MDIX Name Access Type Description 1 Name Get Array of CHAR MDI 2 2 Data type Get UINT8 08h...

Page 107: ...ription 1 Name Get Array of CHAR QuickConnect 2 Data type Get UINT8 08h ENUM 3 Number of elements Get UINT8 01h 4 Descriptor Get UINT8 07h read write shared access 5 Value Get Set ENUM Value Meaning 00h Disable default 01h Enable 6 Configured Value Get ENUM Holds the configured value which will be written to attribute 5 Value Meaning 00h Disable default 01h Enable Instance English German Spanish I...

Page 108: ...00FDX 100 FDX 100 FDX 100 FDX 9 DNS1 DNS 1 DNS Primaria DNS1 DNS1 10 DNS2 DNS 2 DNS Secundia DNS2 DNS2 11 Host name Host name Nombre Host Nome Host Nom hôte 12 Domain name Domain name Nobre Domain Nome Dominio Nom Domaine 13 SMTP Server SMTP Server Servidor SMTP Server SMTP SMTP serveur 14 SMTP User SMTP User Usuario SMTP Utente SMTP SMTP utilisa 15 SMTP Pswd SMTP PSWD Clave SMTP Password SMTP SMT...

Page 109: ...ee Command Details Delete on page 112 Instance Get_Attribute Set_Attribute Bind See Command Details Bind on page 113 Shutdown See Command Details Shutdown on page 114 Listen See Command Details Listen on page 115 Accept See Command Details Accept on page 116 Connect See Command Details Connect on page 117 Receive See Command Details Receive on page 118 Receive_From See Command Details Receive_From...

Page 110: ...FIN_WAIT_2 Have closed FIN is acknowledged 0Ah TIME_WAIT Quiet wait after close 6 TCP RX bytes Get UINT16 Number of bytes in RX buffers TCP sockets only 7 TCP TX bytes Get UINT16 Number of bytes in TX buffers TCP sockets only 8 Reuse address Get Set BOOL Socket can reuse local address Value Meaning 1 Enabled 0 Disabled default 9 Keep alive Get Set BOOL Protocol probes idle connection TCP sockets o...

Page 111: ...command is only allowed in WAIT_PROCESS IDLE and PROCESS_ACTIVE states Command Details Response Details Field Contents CmdExt 0 reserved set to zero CmdExt 1 Value Socket Type 00h SOCK_STREAM NON BLOCKING TCP 01h SOCK_STREAM BLOCKING TCP 02h SOCK_DGRAM NON BLOCKING UDP 03h SOCK_DGRAM BLOCKING UDP Field Contents Comments Data 0 Instance number low Instance number of the created socket Data 1 Instan...

Page 112: ... and a connection is established the connection is terminated with the RST flag To gracefully terminate a TCP connection it is recommended to use the Shutdown command see Command Details Shutdown on page 114 before deleting the socket causing the con nection to be closed with the FIN flag instead Command Details Response Details no data Field Contents Comments CmdExt 0 Instance number to delete lo...

Page 113: ...ription This command binds a socket to a local port Command Details Response Details Field Contents Comments CmdExt 0 Requested port number low Set to 0 zero to request binding to any free port CmdExt 1 Requested port number high Field Contents Comments CmdExt 0 Bound port number low Actual port that the socket was bound to CmdExt 1 Bound port number high ...

Page 114: ...n the send channel note that the receive channel will still be operational 2 Receive data on socket until error message Object specific error EDESTADDRREQ 14 is received indicating that the host closed the receive channel If host does not close the receive chan nel use a timeout and progress to step 3 3 Delete the socket instance If step 2 timed out RST flag will be sent to terminate the socket A ...

Page 115: ... 1 5 Command Details Listen Category Extended Details Command Code 12h Valid for Instance Description This command puts a TCP socket in listening state Command Details Response Details no data Field Contents Comments CmdExt 0 reserved set to zero CmdExt 1 reserved ...

Page 116: ...oming connection request exists the module will respond with error code 0006h EWOULDBLOCK BLOCKING mode This command will block until a connection request has been detected Note This command will only be accepted if there is a free instance to use for accepted connections For blocking connections this command will reserve an instance Command Details no data Response Details Field Contents Data 0 I...

Page 117: ...may dissolve their as sociation by connecting to IP address 0 0 0 0 port 0 zero NON BLOCKING mode This command must be issued repeatedly polled until a connection is connected rejected or timed out The first connect attempt will be accepted thereafter the command will return error code 22 EINPROGRESS on poll requests while attempting to connect BLOCKING mode This command will block until a connect...

Page 118: ...ze is less than requested all available data will be returned NON BLOCKING mode If no data is available on the socket the error code 0006h EWOULDBLOCK will be returned BLOCKING mode The module will not issue a response until the operation has finished If the module responds successfully with 0 zero bytes of data it means that the host has closed the connection The send channel may however still be...

Page 119: ...he socket the error code 0006h EWOULDBLOCK will be returned BLOCKING mode The module will not issue a response until the operation has finished Command Details Response Details Note The data in the response may be segmented see Message Segmentation on page 189 Field Contents Notes CmdExt 0 reserved set to zero CmdExt 1 Segmentation Control bits see Command Segmentation on page 190 Data 0 Receive d...

Page 120: ...nd with er ror code 0006h EWOULDBLOCK BLOCKING mode If there isn t enough buffer space available in the send buffers the module will block until there is Command Details Note To allow larger amount of data i e 255 bytes to be sent the command data may be segmented see Message Segmentation on page 189 Response Details Field Contents Notes CmdExt 0 reserved set to zero CmdExt 1 Segmentation Control ...

Page 121: ...ed see Message Segmentation on page 189 Response Details Field Contents Notes CmdExt 0 reserved set to zero CmdExt 1 Segmentation Control see Command Segmentation on page 190 Data 0 Host IP address byte 3 low The host address port information shall only be included in the first segment All data thereafter must start at Data 0 Data 1 Host IP address byte 2 Data 2 Host IP address byte 1 Data 3 Host ...

Page 122: ...ket an IP multicast group membership The module always joins the All hosts group automatically however this command may be used to specify up to 20 additional member ships Command Details Response Details no data Field Contents Notes CmdExt 0 reserved set to zero CmdExt 1 Data 0 Group IP address byte 3 low Data 1 Group IP address byte 2 Data 2 Group IP address byte 1 Data 3 Group IP address byte 0...

Page 123: ...de 1Ah Valid for Instance Description This command removes the socket from an IP multicast group membership Command Details Response Details no data Field Contents Notes CmdExt 0 reserved set to zero CmdExt 1 Data 0 Group IP address byte 3 low Data 1 Group IP address byte 2 Data 2 Group IP address byte 1 Data 3 Group IP address byte 0 high ...

Page 124: ...lves the given host name and returns the IP address Command Details Response Details Success Field Contents Notes CmdExt 0 reserved set to zero CmdExt 1 Data 0 N Host name Host name to resolve Field Contents Notes CmdExt 0 reserved set to zero CmdExt 1 Data 0 IP address byte 3 low IP address of the specified host Data 1 IP address byte 2 Data 2 IP address byte 1 Data 3 IP address byte 0 high ...

Page 125: ...ket is already in requested mode 11 EINVAL Invalid service data 12 EMSGSIZE Invalid message size 13 EPIPE Error in pipe 14 EDESTADDRREQ Destination address required 15 ESHUTDOWN Socket has already been shutdown 16 reserved 17 EHAVEOOB Out of band data available 18 ENOMEM No internal memory available 19 EADDRNOTAVAIL Address is not available 20 EADDRINUSE Address already in use 21 reserved 22 EINPR...

Page 126: ...on page 105 Supported Commands Object Get_Attribute Create Delete Send email from file Command Details Send Email From File on page 129 Instance Get_Attribute Set_Attribute Send email Command Details Send Email on page 130 Object Attributes Instance 0 Name Access Data Type Value 1 Name Get Array of CHAR SMTP Client 2 Revision Get UINT8 01h 3 Number of instances Get UINT16 4 Highest instance no Get...

Page 127: ... email instance Command Details Response Details Name Access Type Description 1 From Get Set Array of CHAR e g someone somewhere com 2 To Get Set Array of CHAR e g someone else anywhere net 3 Subject Get Set Array of CHAR e g Important notice 4 Message Get Set Array of CHAR e g Duck and cover Field Contents Comments CmdExt 0 reserved set to zero CmdExt 1 Field Contents Comments CmdExt 0 reserved i...

Page 128: ...Net IP Doc Rev 1 5 Command Details Delete Category Extended Details Command Code 04h Valid for Object Description This command deletes an email instance Command Details Response Details no data Field Contents Comments CmdExt 0 reserved ignore CmdExt 1 ...

Page 129: ... command sends an email based on a file in the file system File format The file must be a plain ASCII file in the following format To recipient From sender Subject email subject Headers extra headers optional Message actual email message Command Details Response Details no data Field Contents Comments CmdExt 0 reserved set to zero CmdExt 1 MsgData 0 n Path filename of message file ...

Page 130: ... Instance Description This command sends the specified email instance Command Details no data Response Details no data Object Specific Error Codes Error Codes Meaning 1 SMTP server not found 2 SMTP server not ready 3 Authentication error 4 SMTP socket error 5 SSI scan error 6 Unable to interpret email file 255 Unspecified SMTP error other reserved ...

Page 131: ...eate Command Details Create on page 133 Delete Command Details Delete on page 134 Format Disc Command Details Format Disc on page 143 Instance Get_Attribute File Open Command Details File Open on page 134 File Close Command Details File Close on page 135 File Delete Command Details File Delete on page 135 File Copy Command Details File Copy on page 136 File Rename Command Details File Rename on pa...

Page 132: ...T16 4 Highest instance no Get UINT16 11 Max no of instances Get UINT16 0004h 12 Disable virtual file system Get BOOL False 13 Total disc size Get Array of UINT32 14 Free space Get Array of UINT32 15 Disc CRC Get Array of UINT32 Name Access Type Description 1 Instance type Get UINT8 Value Type 00h Reserved 01h File instance 02h Directory instance 2 File size Get UINT32 File size in bytes zero for d...

Page 133: ... Details Command Code 03h Valid for Object Description This command creates a file operation instance Command Details Response Details Field Contents Comments CmdExt 0 reserved set to zero CmdExt 1 Field Contents Comments CmdExt 0 reserved ignore CmdExt 1 MsgData 0 Instance number low byte MsgData 1 high byte ...

Page 134: ...s no data Command Details File Open Category Extended Details Command Code 10h Valid for Instance Description This command opens a file for reading writing or appending Command Details Response Details no data Field Contents Comments CmdExt 0 reserved ignore CmdExt 1 Field Contents Comments CmdExt 0 Mode Value Mode 00h Read mode 01h Write mode 02h Append mode CmdExt 1 reserved set to zero MsgData ...

Page 135: ...Details File Delete Category Extended Details Command Code 12h Valid for Instance Description This command permanently deletes a specified file from the file system Command Details Response Details no data Field Contents Comments CmdExt 0 reserved ignore CmdExt 1 MsgData 0 File size low byte low word MsgData 1 MsgData 2 MsgData 3 high byte high word Field Contents Comments CmdExt 0 reserved set to...

Page 136: ...ended Details Command Code 13h Valid for Instance Description This command makes a copy of a file Command Details Response Details no data Field Contents Comments CmdExt 0 reserved set to zero CmdExt 1 MsgData 0 n Source path filename Relative to current path separated by NULL NULL Destination path filename ...

Page 137: ...ry Extended Details Command Code 14h Valid for Instance Description This command renames or moves a file Command Details Response Details no data Field Contents Comments CmdExt 0 reserved set to zero CmdExt 1 MsgData 0 n Old path filename Relative to current path separated by NULL NULL New path filename ...

Page 138: ...s Command Code 15h Valid for Instance Description Reads data from a file previously opened for reading Command Details Response Details Field Contents Comments CmdExt 0 Bytes no of bytes to read CmdExt 1 reserved set to zero Field Contents Comments CmdExt 0 reserved ignore CmdExt 1 MsgData 0 n Data Data read from file ...

Page 139: ...nd Details Directory Open Category Extended Details Command Code 20h Valid for Instance Description This command opens a directory Command Details Response Details no data Field Contents Comments CmdExt 0 reserved set to zero CmdExt 1 Data 0 n Data Data to write to file Field Contents Comments CmdExt 0 Bytes no of bytes written CmdExt 1 reserved ignore Field Contents Comments CmdExt 0 reserved set...

Page 140: ...opened directory Command Details no data Response Details no data Command Details Directory Delete Category Extended Details Command Code 22h Valid for Instance Description This command permanently deletes an empty directory from the file system Command Details Response Details no data Field Contents Comments CmdExt 0 reserved set to zero CmdExt 1 MsgData 0 n Path name of directory Relative to cur...

Page 141: ... command must be issued multiple times to retrieve the complete contents of a directory When the last entry has been read the command returns an empty response i e a response where the data size is zero Command Details no data Response Details Field Contents Comments CmdExt 0 reserved ignore CmdExt 1 MsgData 0 Size of entry Low byte low word MsgData 1 MsgData 2 MsgData 3 High byte high word MsgDat...

Page 142: ...mand Details Directory Change Category Extended Details Command Code 25h Valid for Instance Description This command changes the current directory path for an instance Command Details Response Details no data Field Contents Comments CmdExt 0 reserved set to zero CmdExt 1 MsgData 0 n Path name of directory Relative to current path Field Contents Comments CmdExt 0 reserved set to zero CmdExt 1 MsgDa...

Page 143: ...or Codes Field Contents Comments CmdExt 0 reserved set to zero CmdExt 1 Error Codes Meaning 1 Failed to open file 2 Failed to close file 3 Failed to delete file 4 Failed to open directory 5 Failed to close directory 6 Failed to create directory 7 Failed to delete directory 8 Failed to change directory 9 Copy operation failure could not open source 10 Copy operation failure could not open destinati...

Page 144: ...common cases where the end user would use the File System Interface Object An imaginary folder structure will be used in the example with the following files in the root folder Root left jpg navigation js reports weld_current txt weld_formation txt index html up jpg status html test txt right jpg configuration html down jpg weld_info txt ...

Page 145: ...ero bytes returned End InstX File Close Obj Delete InstX Yes No Create a new instance The instance number returned will be used by subsequent commands Open file for reading CmdExt 0 0 and point to the file to open The instance can now be used for file operations Any directory operations will be rejected Read Size number of bytes from the file Keep reading until the Read command returns zero 0 or t...

Page 146: ...Done End InstX File Close Obj Delete InstX Yes No Create a new instance The instance number returned will be used by subsequent commands Open file for reading CmdExt 0 1 and point to the file to open The instance can now be used for file operations Any directory operations will be rejected Write the desired data to the file Keep writing until the desired content has been written Close the file Del...

Page 147: ...stX Directory Close Obj Delete InstX Yes No Create a new instance The instance number returned will be used by subsequent commands Open the report directory The instance can now be used for directory operations Any file operations will be rejected Read the directory entry by entry Keep reading until all entries have been read When there are no more entries this is indicated by a zero data size in ...

Page 148: ...ted Commands Object Get_Attribute Instance Get_Attribute Object Attributes Instance 0 Instance Attributes Instance 1 Extended Name Access Data Type Value 1 Name Get Array of CHAR Network Ethernet 2 Revision Get UINT8 01h 3 Number of instances Get UINT16 4 Highest instance no Get UINT16 Name Access Type Description 1 MAC Address Get Array of UINT8 Current MAC address See also Ethernet Host Object F...

Page 149: ...r of instances Get UINT16 0001h 4 Highest instance no Get UINT16 0001h Name Acce ss Type Description 1 State Get UINT8 Current state of the Safety Modulea 2 Vendor ID Get UINT16 Identifies vendor of the Safety Module a E g 0001h HMS Industrial Networks 3 IO Channel ID Get UINT16 Describes the IO Channels that the Safety Module is equipped with a 4 Firmware version Get Struct of UINT8 Major UINT8 M...

Page 150: ...ses unexpected from the Anybus CompactCom module discarded by the Safety Module SM SE Serial reception errors detected by the Safety Module 9 Event log Get Array of UINT8 Latest Safety Module event information if any is logged to this attribute Any older event information is erased when a new event is logged For evalutation by HMS support 10 Exception information Get UINT8 If the Exception Code in...

Page 151: ...ty application CRC 08h No flash access 09h Answer from wrong safety processor during boot loader communication 0Ah Boot loader timeout 0Bh Network specific parameter error 0Ch Invalid IO configuration string 0Dh Response differed between the safety microprocessors e g different module types 0Eh Incompatible module e g supported network 0Fh Max number of retransmissions performed e g due to CRC err...

Page 152: ...irmation from the application before it can leave the safe state The application sends this command to the Anybus CompactCom module that forwards it to the Safety Module Command Details No data Response Details No data Object Specific Error Codes Error Code Description Comments 0x01 The safety module rejected a message Error code sent by safety module is found in MsgData 2 and MsgData 3 0x02 Messa...

Page 153: ...ces where instance 1 is dedicated to the local TCP port enabling the host application to implement up to 7 additional ports Instance 1 will automatically be populated with default values however it is possible for the host application to customize instance attributes 2 and 4 Apart from attribute 7 it is possible to write to the instance attributes only during setup The host ap plication is respons...

Page 154: ...ect for this port 4 Port Name Set Array of CHAR String max no of characters is 64 which names the port 5 reserved 6 reserved 7 Node Address Set Array of UINT8 Node number of this device on port The data type restricts the range to a Port Segment The encoded port number must match the value specified in attribute 2 A device which does not have a node number on the port can specify a zero length nod...

Page 155: ...tCom 40 Software Design Guide Application Data Object FEh see Anybus CompactCom 40 Software Design Guide Energy Control Object F0h see Anybus CompactCom 40 Software Design Guide Assembly Mapping Object EBh see Anybus CompactCom 40 Software Design Guide Modular Device Object ECh see Anybus CompactCom 40 Software Design Guide Sync Object EEh on page 160 Network Specific Objects CIP Identity Host Obj...

Page 156: ...ifies the safety settings of the application It is mandatory if Functional Safety is to be supported and a safety module is connected to the Anybus CompactCom module Supported Commands Object Get_Attribute Instance Get_Attribute Object Attributes Instance 0 Name Access Data Type Value 1 Name Get Array of CHAR Functional Safety 2 Revision Get UINT8 01h 3 Number of instances Get UINT16 0001h 4 Highe...

Page 157: ...pplication shall never implement this attribute when using the IXXAT Safe T100 3 IO Configuration Get Array of UINT8 Optional attribute Manufacturer specific settings of the digital I O of the safety module See the manual of the safety module used for information 4 Cycle Time Get UINT8 Optional attributea Communication cycle time between the Anybus CompactCom and the safety module in milliseconds ...

Page 158: ...dentity Object 01h on page 63 CIP Supported Commands Object Get_Attribute Instance Get_Attribute Get_Attribute_All Object Attributes Instance 0 Instance Attributes Instance 1 Extended Name Access Data Type Value Description 1 Name Get STRING CIP Identity Object name 2 Revision Get UINT8 01h Object revision 3 Number of instances Get UINT16 Depends on application Supported number of instances 4 High...

Page 159: ...f identity data is requested from the network the Anybus module will issue this command to the application The application will then respond with a message containing a struct of all attributes in the requested instance Command Details no data Response Details Field Contents Notes MsgData 0 1 Vendor ID ABCC CIP identity data MsgData 2 3 Device type MsgData 4 5 Product code MsgData 6 Major revision...

Page 160: ...that consumes data Supported Commands Object Get_Attribute Instance Get_Attribute Set_Attribute Object Attributes Instance 0 Consult the general Anybus CompactCom 40 Software Design Guide for further information Instance Attributes Instance 1 Extended The attributes are represented on EtherNet IP as follows Name Access Type Default Value Comment 1 Cycle time Get Set UINT32 The RPI for the last est...

Page 161: ...id CmdExt 0 Note that some of the commands used when accessing this object may require segmentation For more information see Message Segmentation on page 189 If the module is configured to use EIP QuickConnect functionality the EDS file has to be changed As the EDS file is changed the identity of the module has to be changed and the module will require cer tification see Conformance Test Guide on ...

Page 162: ...mpactCom 40 EtherNet IP TM Name Access Type Default Value Comment 7 Producing Instance No Get Array of UINT16 The values in this array are the EtherNet IP Assembly instance numbers that matches the host application Assembly Mapping Ojbect instances that are listed in attribute 11 Write PD Instance List If the Assembly Mapping Object is not implemented one element in this array is allowed to set th...

Page 163: ... Assembly object Configuration instance number Get UINT16 0005h See also Instance 05h Attributes Configuration Data on page 68 CIP instance 16 Disable Strict IO Match Get BOOL False If true the module will accept Class1 con nection requests that have sizes that s less than or equal to the configured IO sizes 17 Enable uncon nected routing Get BOOL False If true the module enables unconnected CIP r...

Page 164: ...le Use precaution when setting this flag to true HMS will do NO performance measure ments and states NO guarantees about how performance will be affected when copying all data 30 ABCC ADI Object Number Get UINT16 00A2h This attribute either changes the object num ber of the ADI Object or disables the ADI Object see page 83 Valid object numbers are within the vendor specific ranges 0064h 00C7h and ...

Page 165: ...e numbers representing each assembly instance defined by the application The example below shows how the EtherNet IP assembly instances are bound to host application as sembly instances The length of the arrays must match otherwise the module enters exception See also Assembly Mapping Object see Anybus CompactCom 40 Software Design Guide Assembly Mapping Object EBh Instances 1 Read PD 2 Read PD 10...

Page 166: ... Note This command is similar but not identical to the Process_CIP_Request command in the An ybus CompactCom 40 DeviceNet Command Details Response Details IMPORTANT When using this functionality make sure to implement the common CIP Class Attribute attribute 1 Revision for all objects in the host application firmware Failure to observe this will prevent the module from success fully passing confor...

Page 167: ...can both be 0 Normally the Set_Configuration_Data command is sent to the application when an I O connection is setup on the network Producing connection point and consuming connec tion point are available and will be forwarded with the command But if the configuration data originates from a set attribute single request or a not matching NULL forward open request there is no information on the conn...

Page 168: ...P no CIP status code Additional Information 01h Ownership con flict 01h Connection failure The configuration data was supplied in a forward open request 10h Device State con flict The configuration data was supplied in a set request to the Assembly object 02h Invalid configura tion 09h Bad attribute data CIP extended error code Use value from MsgData 2 3 The extended error code shall only be used ...

Page 169: ... the module will reject the originator of the request Resource unavailable and this command will not be issued towards the host application Command Details Response Details See also Port Object F4h on page 85 CIP CIP Port Configuration Object 0Dh on page 153 Field Contents Notes CmdExt 0 reserved ignore CmdExt 1 reserved ignore MsgData 0 n Destination Path Destination path encoded as an EPATH MsgD...

Page 170: ...he module is 458 bytes Note This command must be implemented in order to support Configuration Data If not implement ed the request will be rejected by the Anybus module Command Details Response Details Success Response Details Error See also Message Segmentation on page 189 Field Contents Notes CmdExt 0 00h CmdExt 1 00h MsgData 0 n No extended message data Field Contents Notes CmdExt 0 00h reserv...

Page 171: ...me Access Data Type Value 1 Name Get Array of CHAR Ethernet 2 Revision Get UINT8 02h 3 Number of instances Get UINT16 0001h 4 Highest instance no Get UINT16 0001h Name Access Type Defaulta a If an attribute is not implemented the module will use this value instead Comment 1 MAC addressb b The module is pre programmed with a valid Mac address To use that address do not implement this attribute Get ...

Page 172: ...address Get Array of UINT8 MAC address for Ethernet port 2 6 bytes 11b b If ACD functionality is disabled using this attribute the ACD attributes in the CIP TCP IP object F5h are not avail able Enable ACD Get BOOL True Value Meaning True ACD enabled False ACD disabled 12 Port 1 State Get ENUM Enable State of Ethernet port 1 see Port State on page 173 13 Port 2 State Get ENUM Enable State of Ethern...

Page 173: ...lse No valid link on port 1 4 Link port 2 Value Meaning True Valid link on port 2 False No valid link on port 2 5 15 reserved mask off and ignore Value State Description 00h Enable The Ethernet port is enabled 01h Disable The Ethernet port is disabled The port will be treated as existing i e references to the port can exist in net work protocol website etc 02h Inactivate The Ethernet port is inact...

Page 174: ...ct Get_Attribute Create Command Details Create on page 176 Delete Command Details Delete on page 177 Instance Get_Attribute File Open Command Details File Open on page 177 File Close Command Details File Close on page 178 File Delete Command Details File Delete on page 178 File Copy Command Details File Copy on page 179 File Rename Command Details File Rename on page 180 File Read Command Details ...

Page 175: ... instances Get UINT16 4 Highest instance no Get UINT16 11 Max no of instances Get UINT16 Max number of instances supported by the application 13 Total disc size Get Array of UINT32 14 Free space Get Array of UINT32 Name Access Type Description 1 Instance type Get UINT8 Value Type 00h Reserved 01h File instance 02h Directory instance 2 File size Get UINT32 File size in bytes zero for directories 3 ...

Page 176: ... Details Command Code 03h Valid for Object Description This command creates a file operation instance Command Details Response Details Field Contents Comments CmdExt 0 reserved ignore CmdExt 1 Field Contents Comments CmdExt 0 reserved set to zero CmdExt 1 MsgData 0 Instance number low byte MsgData 1 high byte ...

Page 177: ...ails no data Command Details File Open Category Extended Details Command Code 10h Valid for Instance Description This command opens a file for reading writing or appending Command Details Response Details no data Field Contents Comments CmdExt 0 reserved ignore CmdExt 1 Field Contents Comments CmdExt 0 Mode Value Mode 00h Read mode 01h Write mode 02h Append mode CmdExt 1 reserved ignore MsgData 0 ...

Page 178: ...Details File Delete Category Extended Details Command Code 12h Valid for Instance Description This command permanently deletes a specified file from the file system Command Details Response Details no data Field Contents Comments CmdExt 0 reserved se to zero CmdExt 1 MsgData 0 File size low byte low word MsgData 1 MsgData 2 MsgData 3 high byte high word Field Contents Comments CmdExt 0 reserved ig...

Page 179: ...xtended Details Command Code 13h Valid for Instance Description This command makes a copy of a file Command Details Response Details no data Field Contents Comments CmdExt 0 reserved ignore CmdExt 1 MsgData 0 n Source path filename Relative to current path separated by NULL NULL Destination path filename ...

Page 180: ...gory Extended Details Command Code 14h Valid for Instance Description This command renames or moves a file Command Details Response Details no data Field Contents Comments CmdExt 0 reserved ignore CmdExt 1 MsgData 0 n Old path filename Relative to current path separated by NULL NULL New path filename ...

Page 181: ...s Command Code 15h Valid for Instance Description Reads data from a file previously opened for reading Command Details Response Details Field Contents Comments CmdExt 0 Bytes no of bytes to read CmdExt 1 reserved ignore Field Contents Comments CmdExt 0 reserved set to zero CmdExt 1 MsgData 0 n Data Data read from file ...

Page 182: ...mand Details Directory Open Category Extended Details Command Code 20h Valid for Instance Description This command opens a directory Command Details Response Details no data Field Contents Comments CmdExt 0 reserved ignore CmdExt 1 Data 0 n Data Data to write to file Field Contents Comments CmdExt 0 Bytes no of bytes written CmdExt 1 reserved set to zero Field Contents Comments CmdExt 0 reserved i...

Page 183: ...y opened directory Command Details no data Response Details no data Command Details Directory Delete Category Extended Details Command Code 22h Valid for Instance Description This command permanently deletes an empty directory from the file system Command Details Response Details no data Field Contents Comments CmdExt 0 reserved ignore CmdExt 1 MsgData 0 n Path name of directory Relative to curren...

Page 184: ...mmand must be issued multiple times to retrieve the complete contents of a directory When the last entry has been read the command returns an empty response i e a response where the data size is zero Command Details no data Response Details Field Contents Comments CmdExt 0 reserved set to zero CmdExt 1 MsgData 0 Size of entry Low byte low word MsgData 1 MsgData 2 MsgData 3 High byte high word MsgD...

Page 185: ...a Command Details Directory Change Category Extended Details Command Code 25h Valid for Instance Description This command changes the current directory path for an instance Command Details Response Details no data Field Contents Comments CmdExt 0 reserved ignore CmdExt 1 MsgData 0 n Path name of directory Relative to current path Field Contents Comments CmdExt 0 reserved ignore CmdExt 1 MsgData 0 ...

Page 186: ...ed to close file 3 Failed to delete file 4 Failed to open directory 5 Failed to close directory 6 Failed to create directory 7 Failed to delete directory 8 Failed to change directory 9 Copy operation failure could not open source 10 Copy operation failure could not open destination 11 Copy operation failure write failed 12 Unable to rename file ...

Page 187: ... network protocol The basic functions of the industrial network are used Additional objects etc that will make it possible to certify the product also belong to this category A 2 Extended Use of the objects in this category extends the functionality of the application Access is given to the more specific characteristics of the industrial network not only the basic moving of data to and from the ne...

Page 188: ...plication Watchdog Timeout Handling Upon detection of an application watchdog timeout the module will cease network participation and shift to state EXCEPTION No other network specific actions are performed Anybus State Implementation Comment WAIT_PROCESS The module stays in this state until a Class 1 connection has been opened ERROR 1 Class 1 connections errors 2 Duplicate IP address detected PRO...

Page 189: ...sed by the application it allows very basic segmentation handling The first segment bit FS and the last segment bit LS shall always be set in each segmented command or response In the Anybus CompactCom 40 series some commands in the Socket Interface Object page 109 and in the EtherNet IP Host Object 161 use segmentation If a shorter message size is implemented segmentation has to be used setting t...

Page 190: ...ng a segmented command the following rules apply When issuing the first segment FS must be set When issuing subsequent segments both FS and LS must be cleared When issuing the last segment the LS bit must be set For single segment commands i e size less or equal to 255 bytes both FS and LS must be set The last response message contains the actual result of the operation The command initiator may a...

Page 191: ... Command Details Get_Configuration_Data on page 170 Segmentation Control bits Command Segmentation Control bits Response When receiving a segmented response the following rules apply In the first segment FS is set In all subsequent segment both FS and LS are cleared In the last segment LS is set For single segment responses i e size less or equal to 255 bytes both FS and LS are set The command ini...

Page 192: ...he Anybus IPconfig utility for changing set tings e g IP address Subnet mask and enable disable DHCP Anybus IPconfig can be downloaded free of charge from the HMS website www anybus com This utility may be used to access the network settings of any Anybus product connected to the network via UDP port 3250 The protocol offers secure authentication and the ability to restart reboot the device s ...

Page 193: ...ctivity LED port 2 LED State Description Off No power or no IP address Green Online one or more connections established CIP Class 1 or 3 Green flashing Online no connections established Red Duplicate IP address FATAL error Red flashing One or more connections timed out CIP Class 1 or 3 LED State Description Off No power Green Controlled by a Scanner in Run state Green flashing Not configured or Sc...

Page 194: ...the power consumption classification used on the Anybus CompactCom 40 platform consult the general Anybus CompactCom 40 Hardware Design Guide The current hardware design consumes up to 360 mA1 Note It is strongly advised to design the power supply in the host application based on the power con sumption classifications described in the general Anybus CompactCom Hardware Design Guide and not on the ...

Page 195: ... in the NW_INIT state Category Parameters Page Startup Delay T1 T2 195 NW_INIT Handling T100 195 Event Based WrMsg Busy Time T103 196 Event Based Process Data Delay T101 T102 196 Parameter Description Max Unit T1 The Anybus CompactCom 40 EtherNet IP module generates the first application inter rupt parallel mode 64 ms T2 The Anybus CompactCom 40 EtherNet IP module is able to receive and handle the...

Page 196: ...s to when the first bit of the new process data frame is sent out on the network The test was run in 16 bit parallel event mode with interrupts triggered only for new process data events The delay added by the PHY circuit has not been included as this delay is insignificant compared to the total process data delay Parameter Description Min Max Unit T103 H_WRMSG area busy time 6 9 μs Parameter Desc...

Page 197: ...IGENCE OR OTHER WISE ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE EVEN IF ADVISED OF THE POSSI BILITY OF SUCH DAMAGE Print formatting routines Copyright C 2002 Michael Ringgaard All rights reserved Redistribution and use in source and binary forms with or without modification are permitted provided that the following conditions are met 1 Redistributions of source code must retain the above c...

Page 198: ...the following conditions The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software THE SOFTWARE IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND EXPRESS OR IMPLIED IN CLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE ANDNONINFRINGEMENT IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE ...

Reviews:

No comments

Brands by name

0 1 2 3 4 5 6 7 8 9 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Popular brands

Load more brands