manualshive.com logo in svg

Anybus CompactCom 40 Common Ethernet, Design Manual

Share
Download
Anybus CompactCom 40 Common Ethernet Design Manual Download Page 91

Host Application Objects

89 (104)

11

Host Application Objects

11.1

General Infomration

This chapter specifies the host application object implementation in the module. The objects
listed here may optionally be implemented within the host application firmware to expand the
implementation.

Standard Objects:

•

Application Object (see Anybus CompactCom 40 Software Design Guide)

•

Application Data Object (see Anybus CompactCom 40 Software Design Guide)

Network Specific Objects

•

Application File System Interface Object (EAh), p. 90

•

Ethernet Host Object (F9h), p. 91

Anybus

®

CompactCom

™

40 Common Ethernet Design Guide

HMSI-27–269 2.1

Summary of Contents for CompactCom 40 Common Ethernet

Page 1: ...Anybus CompactCom 40 Common Ethernet DESIGN GUIDE HMSI 27 269 2 1 ENGLISH...

Page 2: ...odes 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...

Page 3: ...ation 8 3 1 General Information 8 3 2 Software Requirements 8 3 3 Device Customization 8 3 4 Communication Settings 9 3 5 Diagnostics 11 3 6 Network Data Exchange 11 3 7 File System 11 4 Firmware Down...

Page 4: ...work Object 03h 57 10 5 Network Configuration Object 04h 58 10 6 Socket Interface Object 07h 65 10 7 SMTP Client Object 09h 82 10 8 Anybus File System Interface Object 0Ah 87 10 9 Network Ethernet Obj...

Page 5: ...Design Guide HMSI 27 269 2 1 Table of Contents D Technical Specification 98 D 1 Front View 98 D 2 Functional Earth FE Requirements 99 D 3 Power Supply 99 D 4 Environmental Specification 99 D 5 EMC Co...

Page 6: ...This page intentionally left blank...

Page 7: ...their implementation in such a way that this is not necessary For additional related documentation and file downloads please visit the support website at www anybus com support 1 2 Related Documents...

Page 8: ...t or to avoid a network security risk Caution This instruction must be followed to avoid a risk of personal injury WARNING This instruction must be followed to avoid a risk of death or serious injury...

Page 9: ...ear as a vendor specific implementation rather than a generic Anybus module This product conforms to all aspects of the host interface for Anybus CompactCom 40 modules defined in the Anybus CompactCom...

Page 10: ...he command Get_Instance_Number_By_ Order Application Data Object FEh is implemented in the host application For in depth information regarding the Anybus CompactCom 40 software interface consult the g...

Page 11: ...n See also Socket Interface Object 07h p 65 Message Segmentation p 80 3 4 Communication Settings As with other Anybus CompactCom products network related communication settings are grouped in the Netw...

Page 12: ...mented 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...

Page 13: ...pactCom 40 Common Ethernet has an in built file system that can be ac cessed from the application and from the network Three directories are predefined VFS The virtual file system that e g holds the w...

Page 14: ...Application File system File A1 File A2 Directory A1 File A1 1 File A1 2 The Anybus CompactCom accesses the application file system through the Application File System Interface Object Anybus Compact...

Page 15: ...me included See also FTP Server p 16 Web Server p 18 E mail Client p 24 Server Side Include SSI p 25 Anybus File System Interface Object 0Ah p 87 Application File System Interface Object EAh p 90 The...

Page 16: ...d find the module 4 Click the Firmware Repository icon in the menu to open the Firmware Repository window Drag the firmware folder into the window to add the new firmware to the repository Close the F...

Page 17: ...ile system can be accessed through FTP or via the File System Interface Object The next time the module is started the new firmware will be installed After the firmware is installed the firmware file...

Page 18: ...eir 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 c...

Page 19: ...only 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 5 3 Session Examp...

Page 20: ...k 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 The...

Page 21: ...ce for changing TCP IP and SMTP settings in the Network Configuration Object Fig 5 Fig 6 The module needs to be reset for the TCP IP and SMTP settings to take effect The Ethernet Configuration setting...

Page 22: ...IP address or name Max 64 characters User Max 64 characters Password Max 64 characters Confirm password 6 2 2 Ethernet Statistics Page The Ethernet statistics web page contains the following informati...

Page 23: ...on of an interface fails due to an internal MAC sublayer receive error MAC Transmit Errors Frames for which transmission fails due to an internal MAC sublayer re ceive error Carrier Sense Errors Times...

Page 24: ...WebRoot with the web root directory specified in http cfg If no index page is found the module will default to the virtual index file if enabled See also Default web pages 6 3 3 Default Content Types...

Page 25: ...pproved users can optionally be redirected to one or several other files If the list of approved users is put in another file be aware that this file can be accessed and read from the network In the f...

Page 26: ...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 username A valid password To send an e mail...

Page 27: ...tion includes the contents of a file The content is scanned for SSI This function cannot be used in e mail messages Syntax include file filename filename Source file Scenario Default Output Success co...

Page 28: ...yN valueN Syntax exec cmd_argument GetConfigItem filename key separator filename Source file to read from key Source key in file separator Optional specifies line separation characters e g br default...

Page 29: ...ple The following SSI exec cmd_argument GetConfigItem example cnf B in combination with the following file example cnf A First B Second C Third returns the string Third Anybus CompactCom 40 Common Eth...

Page 30: ...nderscore will not be stored Syntax exec cmd_argument SetConfigItem filename Overwrite filename Destination file If the specified file does not exist it will be created provided that the path is valid...

Page 31: ...T 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 t...

Page 32: ...n 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 Configurat...

Page 33: ...ut Scenario Default Output Success Language changed Error Failed to change language Example The following example demonstrates how to use this function The resulting page sends a form to itself which...

Page 34: ...o Default Output Success file contents Authentication Error Authentication error File Open Error Failed to open file filename Example The following example demonstrates how to use this function HTML H...

Page 35: ...ver Side Include SSI 33 104 When viewed in a browser the resulting page should look somewhat as follows Fig 7 See also Include File p 25 Anybus CompactCom 40 Common Ethernet Design Guide HMSI 27 269 2...

Page 36: ...will be created provided that the path is valid source Optional by specifying a form object only data from that particular form object will be stored Default behavior is to store data from all form o...

Page 37: ...rwrite FORM action test shtm P LABEL for Fruit Fruit LABEL BR INPUT type text name Fruit BR BR LABEL for Meat Meat LABEL BR INPUT type text name Meat BR BR LABEL for Meat Bread LABEL BR INPUT type tex...

Page 38: ...are substituted by subsequent arguments and format ted as requested The number of format tags must match the number of arguments if not the result is undefined See section Formatting Tags below for mo...

Page 39: ...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 Optional Width Meaning number Specifies the minimum numb...

Page 40: ...object from which the string shall be extracted template Template which specifies how to parse and interpret the data May contain any number of formatting tags which determine the conversion prior to...

Page 41: ...a decimal ra tional number followed by an exponent field which con sists of an E or an e followed by an integer FLOAT n Consumes no input the corresponding argument is an integer into which scanf wri...

Page 42: ...he Destination Instance command Specifies the Command Number ce0 Specifies CmdExt 0 for the command message ce1 Specifies CmdExt 1 for the command message msgdata Specifies the actual contents of the...

Page 43: ...e In such case the actual data type returned from the function will be STRING Syntax BOOL true false For arrays the format will be BOOL n true false SINT8 Yes SINT16 Yes SINT32 Yes UINT8 Yes This type...

Page 44: ...bit integers Example Set_Attribute This example shows how to set the IP address using scanf and ABCCMessage Note the special parameter value ARG which instructs the module to use the passed form data...

Page 45: ...bject 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...

Page 46: ...n error string 3 File write error string Use s to include the name of the file IncludeFile_X 0 Success string 1 Authentication error string 2 File read error string Use s to include the name of the fi...

Page 47: ...as UTF 8 en coded while all other HTTP requests will be interpreted as ISO 8859 1 encoded All JSON re sponses sent by the module are UTF 8 encoded while all other files sent by the web server are enco...

Page 48: ...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 Name Data Type Not...

Page 49: ...json POSTadi 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...

Page 50: ...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 JSON object layout modulename ABCC M40 serial ABCDEF00 fwver...

Page 51: ...below comm2 Object See object definition in the table below Comm Object Definition 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 JSON...

Page 52: ...ateway String dns1 String dns2 String hostname String domainname String dhcp 0 addr 192 168 0 55 subnet 255 255 255 0 gateway 192 168 0 1 dns1 10 10 55 1 dns2 10 10 55 2 hostname hostname domainname h...

Page 53: ...frames which experienced ex actly one collision multicoll Number Successfully transmitted frames which experienced more than one collision latecoll Number Number of collisions detected later than 512...

Page 54: ...t identifier bacnetapl title BACnet APL Statistics Get network specific statistics GET network nwstats json get ID ID is an identifier value returned from the previous command eip for example name Est...

Page 55: ...PU load from the module and presents it on the web page The file containing this code has to be stored in the built in file system and the result can be seen in a common browser html head title Anybus...

Page 56: ...Objects Anybus Object 01h p 55 Diagnostic Object 02h p 56 Network Object 03h p 57 Network Configuration Object 04h p 58 Network Specific Objects Socket Interface Object 07h p 65 SMTP Client Object 09...

Page 57: ...urther information Instance Attributes Instance 1 Basic Name Access Type Value 1 Module type Get UINT16 0403h Standard Anybus CompactCom 40 2 11 Consult the general Anybus CompactCom 40 Software Desig...

Page 58: ...lways be one instance reserved for an event of severity level Major unrecoverable to force the module into the EXCEPTION state 12 Supported functionality Get BITS32 Bit 0 0 Latching events are not sup...

Page 59: ...ype Value 1 Name Get Array of CHAR Network 2 Revision Get UINT8 02h 3 Number of instances Get UINT16 01h 4 Highest instance number Get UINT16 01h Consult the general Anybus CompactCom 40 Software Desi...

Page 60: ...ring Object Attributes Instance 0 Name Access Data Type Value 1 Name Get Array of CHAR Network Configuration 2 Revision Get UINT8 01h 3 Number of instances Get UINT16 000Fh 15 4 Highest instance numbe...

Page 61: ...r 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...

Page 62: ...X 10Mbit full duplex 03h 100HDX 100Mbit half duplex 04h 100FX 100Mbit full duplex Instance Attributes Instance 8 Ethernet Communication Settings 2 Changes have immediate effect Name Access Data Type D...

Page 63: ...64 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 V...

Page 64: ...HAR 3 Number of elements Get UINT8 40h 64 elements 4 Descriptor Get UINT8 07h read write shared access 5 Value Get Set Array of CHAR Any change is valid after reset SMTP server address 64 characters 6...

Page 65: ...I 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 Value Get Set ENUM Value ENUM 00h 01h 02h String Meaning Auto de...

Page 66: ...ssione 1 Comm 1 Auto Auto Auto Auto Auto 10 HDX 10 HDX 10 HDX 10 HDX 10 HDX 10 FDX 10 FDX 10 FDX 10 FDX 10 FDX 100 HDX 100 HDX 100 HDX 100 HDX 100 HDX 100 FDX 100FDX 100 FDX 100 FDX 100 FDX 8 Comm 2 K...

Page 67: ...understands the concepts involved in TCP IP programming Supported Commands Object Get_Attribute Create See below Delete See below DNS_Lookup See below Instance Get_Attribute Set_Attribute Bind See bel...

Page 68: ...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 1 0 Me...

Page 69: ..._ACTIVE states Command Details Field Contents CmdExt 0 reserved set to zero CmdExt 1 Value 00h 01h 02h 03h Socket Type SOCK_STREAM NON BLOCKING TCP SOCK_STREAM BLOCKING TCP SOCK_DGRAM NON BLOCKING UDP...

Page 70: ...nstead Command Details Field Contents Comments CmdExt 0 Instance number to delete low Instance number of socket that shall be deleted CmdExt 1 Instance number to delete high Response Details no data C...

Page 71: ...ates shutdown 1 Send shutdown with CmdExt 1 set to 01h This will send FIN flag to host shutting down the send chan nel note that the receive channel will still be operational 2 Receive data on socket...

Page 72: ...ails Command Code 12h Valid for Instance Description This command puts a TCP socket in listening state Command Details Field Contents CmdExt 0 reserved set to zero CmdExt 1 reserved Response Details n...

Page 73: ...ith error code 0006h EWOULDBLOCK BLOCKING mode This command will block until a connection request has been detected This command will only be accepted if there is a free instance to use for accepted c...

Page 74: ...P 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 thereafte...

Page 75: ...LOCKING 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 r...

Page 76: ...e The module will not issue a response until the operation has finished Command Details Field Contents Comments CmdExt 0 reserved set to zero CmdExt 1 Segmentation Control bits For more information se...

Page 77: ...isn t enough buffer space available in the send buffers the module will block until there is Command Details To allow larger amount of data i e 255 bytes to be sent the command data may be segmented F...

Page 78: ...ield Contents Comments CmdExt 0 reserved set to zero CmdExt 1 Segmentation Control For more information see Message Segmentation p 80 Data 0 Host IP address byte 4 The host address port information sh...

Page 79: ...a 0 Group IP address byte 4 Data 1 Group IP address byte 3 Data 2 Group IP address byte 2 Data 3 Group IP address byte 1 Response Details no data Command Details IP_Drop_Membership Category Extended D...

Page 80: ...and Details Field Contents Comments CmdExt 0 reserved set to zero CmdExt 1 Data 0 N Host name Host name to resolve Response Details Success Field Contents Comments CmdExt 0 reserved set to zero CmdExt...

Page 81: ...vice 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 av...

Page 82: ...message the data field is exchanged with the next data segment Command segmentation is used for the following commands Socket Interface Object specific commands Send Send To When issuing a segmented...

Page 83: ...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 the message channel size both FS and LS are set The command initiato...

Page 84: ...INT16 4 Highest instance no Get UINT16 11 Max no of instances Get UINT16 0006h 12 Success count Get UINT16 Reflects the no of successfully sent messages 13 Error count Get UINT16 Reflects the no of me...

Page 85: ...ription This command creates an e mail instance Command Details Field Contents Comments CmdExt 0 reserved set to zero CmdExt 1 Response Details Field Contents Comments CmdExt 0 reserved ignore CmdExt...

Page 86: ...Command Code 04h Valid for Object Description This command deletes an e mail instance Command Details Field Contents Comments CmdExt 0 E mail instance number low byte CmdExt 1 high byte Response Deta...

Page 87: ...the file system The file must be a plain ASCII file in the following format To recipient From sender Subject email subject Se Headers extra headers optional Message actual email message Command Detai...

Page 88: ...e mail 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 e...

Page 89: ...e stream and contains services for file system operations This provides the host application with access to the built in file system of the module e g when application specific web pages are to be ins...

Page 90: ...t_Attribute Object Attributes Instance 0 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 UINT1...

Page 91: ...e implemented within the host application firmware to expand the implementation Standard Objects Application Object see Anybus CompactCom 40 Software Design Guide Application Data Object see Anybus Co...

Page 92: ...ach instance represents a handle to a file stream and contains services for file system operations This allows the user to download software through the FTP server to the application The application d...

Page 93: ...y zz aa bb 01 xx yy zz aa bb 02 and xx yy zz aa bb 03 with the first five octets not changing Name Ac cess Data Type Default Value Comment 1 MAC address Get Array of UINT8 6 byte physical address valu...

Page 94: ...bute is not read by EtherCAT devices where Port 1 is always enabled This attribute is not used by PROFINET 00h Enabled 01h Disabled The port is treated as existing References to the port can exist e g...

Page 95: ...munity string Max length is 32 22 DHCP Option 61 source Get ENUM 0 Disabled Note This attribute is currently only valid for Ethernet IP devices See below DHCP Option 61 Client Identifier 23 DHCP Optio...

Page 96: ...s the Client Identifier 3 Generic String Attribute 23 will be used as the Client Identifier Attribute 23 DHCP Option 61 generic string is used to set the Client Identifer when Attribute 22 has been se...

Page 97: ...dustrial 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 functionali...

Page 98: ...an only change to ER ROR or EXCEPTION ERROR Duplicate IP address detected PROCESS_ACTIVE The module shall never enter any of these states IDLE EXCEPTION Unexpected error e g watchdog timeout etc MS LE...

Page 99: ...and the ability to restart reboot the device s C 2 Operation When the application is started the network is automatically scanned for Anybus products The network can be rescanned at any time by click...

Page 100: ...2 L2 Module Status LED 3 Link Activity LED port 1 4 Link Activity LED port 2 Test sequences are performed on the Network and Module Status LEDs during startup D 1 2 Network Status LED LED State Descri...

Page 101: ...s CompactCom 40 Common Ethernet requires a regulated 3 3 V power source as specified in the general Anybus CompactCom 40 Hardware Design Guide D 3 2 Power Consumption TheAnybus CompactCom 40 Common Et...

Page 102: ...is software and associated documentation files the Software to deal in the Software without restriction including without limitation the rights to use copy modify merge publish distribute sublicense a...

Page 103: ...urce 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 copyright notice this list of con...

Page 104: ...ER IN CONTRACT STRICT LIABILITY OR TORT INCLUDING NEGLIGENCE OR OTHERWISE ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE EVEN IF AD VISED OF THE POSSIBILITY OF SUCH DAMAGE Print formatting routine...

Page 105: ...OR ANY DIRECT INDIRECT INCIDENTAL SPECIAL EXEMPLARY OR CONSEQUENTIAL DAMAGES INCLUDING BUT NOT LIMITED TO PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES LOSS OF USE DATA OR PROFITS OR BUSINESS INTERRUPTI...

Page 106: ...last page 2017 HMS Industrial Networks AB Box 4126 300 04 Halmstad Sweden info hms se HMSI 27 269 2 1 4666 2017 07 10T11 06 42...

Reviews:

No comments

Brands by name

Popular brands

Load more brands