Anybus CompactCom 40 Common Ethernet Guide

Anybus®CompactCom™40
Common Ethernet
DESIGN GUIDE
HMSI-27–269 2.1 ENGLISH

Important User Information
Liability
Every care has been taken in the preparation of this document. Please inform HMS Industrial Networks AB of any
inaccuracies or omissions. The data and illustrations found in this document are not binding. We, HMS Industrial
Networks AB, reserve the right to modify our products in line with our policy of continuous product development.
The information in this document is subject to change without notice and should not be considered as a commit-
ment by HMS Industrial Networks AB. HMS Industrial Networks AB assumes no responsibility for any errors that
may appear in this document.
There are many applications of this product. Those responsible for the use of this device must ensure that all the
necessary steps have been taken to verify that 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 by any direct or indirect use of such aspects of the product
are undefined, and may include e.g. compatibility issues and stability issues.
The examples and illustrations in this document are included solely for illustrative purposes. Because of the many
variables and requirements associated with any particular implementation, HMS Industrial Networks AB cannot as-
sume responsibility for actual use based on these examples and illustrations.
Intellectual Property Rights
HMS Industrial Networks AB has intellectual property rights relating to technology embodied in the product de-
scribed in this document. These intellectual property rights may include patents and pending patent applications in
the USA and other countries.
Anybus®CompactCom™40 Common Ethernet Design Guide HMSI-27–269 2.1

Anybus®CompactCom™40 Common Ethernet Design Guide HMSI-27–269 2.1
Table of Contents Page
1 Preface ............................................................................................................................... 5
1.1 About this document ......................................................................................................5
1.2 Related Documents .......................................................................................................5
1.3 Document History ..........................................................................................................5
1.4 Document Conventions ..................................................................................................5
1.5 Document Specific Conventions......................................................................................6
1.6 Trademark Information ...................................................................................................6
2 About the Anybus CompactCom 40 Common Ethernet ....................................... 7
2.1 General.........................................................................................................................7
2.2 Features .......................................................................................................................7
3 Basic Operation............................................................................................................... 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 Download / Firmware Upgrade ............................................................... 14
4.1 Using Firmware Manager II...........................................................................................14
4.2 Via the Internal File System ..........................................................................................15
5 FTP Server ...................................................................................................................... 16
5.1 General Information .....................................................................................................16
5.2 User Accounts .............................................................................................................16
5.3 Session Example .........................................................................................................17
6 Web Server...................................................................................................................... 18
6.1 General Information .....................................................................................................18
6.2 Default Web Pages ......................................................................................................18
6.3 Server Configuration ....................................................................................................21
7 E-mail Client ................................................................................................................... 24
7.1 General Information .....................................................................................................24
7.2 How to Send E-mail Messages .....................................................................................24

Anybus®CompactCom™40 Common Ethernet Design Guide HMSI-27–269 2.1
Table of Contents
8 Server Side Include (SSI) ............................................................................................ 25
8.1 General Information .....................................................................................................25
8.2 Include File..................................................................................................................25
8.3 Command Functions ....................................................................................................25
8.4 Argument Functions.....................................................................................................40
8.5 SSI Output Configuration..............................................................................................44
9 JSON................................................................................................................................. 45
9.1 General Information .....................................................................................................45
9.2 JSON Objects..............................................................................................................45
9.3 Example......................................................................................................................53
10 Anybus Module Objects .............................................................................................. 54
10.1 General Information .....................................................................................................54
10.2 Anybus Object (01h) ....................................................................................................55
10.3 Diagnostic Object (02h) ................................................................................................56
10.4 Network 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 Object (0Ch) .....................................................................................88
11 Host Application Objects ............................................................................................ 89
11.1 General Infomration .....................................................................................................89
11.2 Application File System Interface Object (EAh)...............................................................90
11.3 Ethernet Host Object (F9h) ...........................................................................................91
A Categorization of Functionality ................................................................................. 95
A.1 Basic...........................................................................................................................95
A.2 Extended.....................................................................................................................95
B Implementation Details................................................................................................ 96
B.1 SUP-Bit Definition ........................................................................................................96
B.2 Anybus State Machine .................................................................................................96
B.3 Application Watchdog Timeout Handling ........................................................................96
C Secure HICP (Secure Host IP Configuration Protocol) ....................................... 97
C.1 General.......................................................................................................................97
C.2 Operation ....................................................................................................................97

Anybus®CompactCom™40 Common Ethernet 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 Compliance.........................................................................................................99
E Copyright Notices .......................................................................................................100

This page intentionally left blank

Preface 5 (104)
1 Preface
1.1 About this document
This document is intended to provide a good understanding of the functionality offered by the
Anybus CompactCom 40 Common Ethernet. The document describes the features that are
specific to Anybus CompactCom 40 Common Ethernet. For general information regarding Any-
bus CompactCom 40, consult the Anybus CompactCom 40 design guides.
The reader of this document is expected to be familiar with high level software design and com-
munication systems in general. The information in this network guide should normally be suffi-
cient to implement a design. However if advanced Ethernet specific functionality is to be used,
in-depth knowledge of Ethernet networking internals and/or information from the official Ether-
net specifications may be required. In such cases, the persons responsible for the implementa-
tion of this product should either obtain the Ethernet specification to gain sufficient knowledge
or limit 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
Document Author Document ID
Anybus CompactCom 40 Software Design Guide HMS HMSI-216–125
Anybus CompactCom M40 Hardware Design Guide HMS HMSI-216–126
Anybus CompactCom B40 Design Guide HMS HMSI-27-230
Anybus CompactCom Host Application Implementation
Guide
HMS HMSI-27-334
Anybus CompactCom 40 Network Guides HMS
1.3 Document History
Version Date Description
1.00 2014-09-09 First release
1.01 2014-09-10 Minor corrections
1.05 2014-09-22 Major update
1.06 2015-01-22 Minor update
1.10 2015-11-04 Minor update
2.0 2017–01–23 Moved from FM to DOX
Misc. updates.
2.1 2017–07–10 Misc. updates to common objects
1.4 Document Conventions
Ordered lists are used for instructions that must be carried out in sequence:
1. First do this
2. Then do this
Unordered (bulleted) lists are used for:
• Itemized information
• Instructions that can be carried out in any order
...and for action-result type instructions:
Anybus®CompactCom™40 Common Ethernet Design Guide HMSI-27–269 2.1

Preface 6 (104)
► This action...
➨leads to this result
Bold typeface indicates interactive parts such as connectors and switches on the hardware, or
menus and buttons in a graphical user interface.
Monospaced text is used to indicate program code and other
kinds of data input/output such as configuration scripts.
This is a cross-reference within this document: Document Conventions, p. 5
This is an external link (URL): www.hms-networks.com
This is additional information which may facilitate installation and/or operation.
This instruction must be followed to avoid a risk of reduced functionality and/or
damage to the equipment, 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.
1.5 Document Specific Conventions
• The terms “Anybus” or “module” refers to the Anybus CompactCom module.
• The terms “host” or “host application” refer to the device that hosts the Anybus.
• Hexadecimal values are written in the format NNNNh or 0xNNNN, where NNNN is the hex-
adecimal value.
• A byte always consists of 8 bits.
• The terms “basic” and “extended” are used to classify objects, instances and attributes.
1.6 Trademark Information
Anybus®is a registered trademark of HMS Industrial Networks AB.
All other trademarks are the property of their respective holders.
Anybus®CompactCom™40 Common Ethernet Design Guide HMSI-27–269 2.1

About the Anybus CompactCom 40 Common Ethernet 7 (104)
2 About the Anybus CompactCom 40 Common
Ethernet
2.1 General
The Anybus CompactCom 40 Common Ethernet communication module provides a common
platform for the Industrial Ethernet networks, that are supported in the Anybus CompactCom 40
product family. The communication software for the selected network is downloaded to the mod-
ule and the module will seamlessly integrate to the network. It is also possible to use the module
as a general Ethernet interface, using the included TCP/IP stack (See Socket Interface Object
(07h), p. 65). The modular approach of the Anybus CompactCom 40 platform allows the module
to be customized, allowing the end product to appear 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 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 functionality, a certain de-
gree of dedicated software support may be necessary.
2.2 Features
• Two Ethernet ports
• Ethernet RJ45 connectors
• Common hardware platform for Ethernet networks
• 10/100 Mbit, full/half duplex operation
• Web server w. customizable content
• FTP server
• E-mail client
• JSON functionality
• Server Side Include (SSI) functionality
• Transparent Socket Interface
Anybus®CompactCom™40 Common Ethernet Design Guide HMSI-27–269 2.1

Basic Operation 8 (104)
3 Basic Operation
3.1 General Information
At delivery the module supports general Ethernet functionality, such as e.g. FTP and web serv-
er. The built in socket interface allows additional protocols to be implemented on top of TCP/IP,
see Socket Interface (Advanced Users Only), p. 9.
Firmware to enable communication with another network, can be downloaded in different ways,
see Firmware Download / Firmware Upgrade, p. 14.
3.2 Software Requirements
Generally, no additional network support code needs to be written in order to support the Any-
bus CompactCom 40 Common Ethernet. However, certain restrictions must be taken into
account.
• Certain functionality in the module requires that the 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
general Anybus CompactCom 40 Software Design Guide.
See also...
•Diagnostic Object (02h), p. 56 (Anybus Module Ojbects
• Anybus CompactCom 40 Software Design Guide, Application Data Object (FEh)
3.3 Device Customization
3.3.1 Network Identity
By default, the module uses the following identity settings:
Vendor ID 005Ah (HMS Industrial Networks)
Device Type 002Bh (Generic Device)
Product Code 00A3h (Common Ethernet)
Product Name “Anybus CompactCom 40 Common Ethernet”
Depending on network downloaded, it is possible to customize the identity of the module by im-
plementing the corresponding instance attributes in the respective network Host Objects.
Anybus®CompactCom™40 Common Ethernet Design Guide HMSI-27–269 2.1

Basic Operation 9 (104)
3.3.2 Web Interface
The web interface can be fully customized to suit a particular application. Dynamic content can
be created by means JSON and SSI scripting. Data and web pages are stored in a FLASH-
based file system, which can be accessed using any standard FTP-client or the File System In-
terface Object.
See also...
•File System, p. 11
•FTP Server, p. 16
•Web Server, p. 18
•Server Side Include (SSI), p. 25
•JSON, p. 45
3.3.3 Socket Interface (Advanced Users Only)
The built in socket interface allows additional protocols to be implemented on top of TCP/IP. Da-
ta is structured by the application and is then embedded within the Ethernet frames. The host
application can open network connections of its own to other nodes on the network, e.g. if you
want to connect to another server or use a web server of your own.
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 Network Configuration Object (04h).
In this case, this includes...
TCP/IP settings These settings must be set properly in order for the module to be able to
participate on the network.
The module supports DHCP, which may be used to retrieve the TCP/IP settings
from 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.
See also...
•Web Server, p. 18
•Network Configuration Object (04h), p. 58
•Secure HICP (Secure Host IP Configuration Protocol), p. 97
Anybus®CompactCom™40 Common Ethernet Design Guide HMSI-27–269 2.1

Basic Operation 10 (104)
3.4.1 Communication Settings in Stand Alone Shift Register Mode
If the Anybus CompactCom 40 is used stand alone, there is no application from which to set the
IP address. The IP address is instead set using the DIP1 switches (IP address byte 3) and the
virtual attributes (Ethernet Host object (F9h), attribute #17), that are written to memory during
setup (IP address byte 0 - 2). A flowchart is shown below.
Start
DIP1 switch settings
(0 - 255)
2550
1 - 254
Values stored in
Network Conguration
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
Conguration Object (04h),
instance #3
Check for DHCP
availability
Yes
No
DHCP will be used for
communication settings,
that will be stored in
Network Conguration
Object (04h), instances #3 - #6
Values stored in
Network Conguration
Object instances #3 - #6
will be used
Network Conguration Object (04h)
Instance #4, Subnet mask: 255.255.255.0
Instance #5 Gateway address: 0.0.0.0
Instance 6, DHCP: OFF
Fig. 1
See also...
•Ethernet Host Object (F9h), p. 91
• Anybus CompactCom M40 Hardware Design Guide
•Network Configuration Object (04h), p. 58
Anybus®CompactCom™40 Common Ethernet Design Guide HMSI-27–269 2.1

Basic Operation 11 (104)
3.5 Diagnostics
Events and their severity value are recorded in the Diagnostic Object.
See also...
•Diagnostic Object (02h), p. 56
3.6 Network Data Exchange
The Anybus CompactCom 40 Common Ethernet does not perform any network specific han-
dling of the process data.
For information on network data exchange for supported networks, please consult the respec-
tive network guides, available at www.anybus.com/support.
3.7 File System
Category: Extended
3.7.1 Overview
The Anybus CompactCom 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 web pages of the module. The virtual file
system is enabled by default in the Anybus File System Interface Object (0Ah).
Application This directory provides access to the application file system through the
Application File System Interface Object (EAh) (optional).
Firmware Firmware updates are stored in this directory.
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™40 Common Ethernet Design Guide HMSI-27–269 2.1

Basic Operation 12 (104)
Anybus
CompactCom
File system
File 1
File 2
VFS
File 1
File 2
Application
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 CompactCom Application
Firmware
Fig. 2
Anybus®CompactCom™40 Common Ethernet Design Guide HMSI-27–269 2.1

Basic Operation 13 (104)
3.7.2 General Information
The built-in file system hosts 28 MByte of non volatile storage, which can be accessed by the
HTTP and FTP servers, the email client, and the host application (through the Anybus File Sys-
tem Interface Object (0Ah)).
The maximum number of directories and files, that can be stored in the root directory, is 511 if
only short filenames are used (8 bytes name + 3 bytes extension). The number of files that can
be stored in other directories, than the root directory, is unlimited.
The file system uses the following conventions:
• \ (backslash) is used as a path separator
• Names may contain spaces, but must not begin or end with one.
• Valid characters in names are ASCII character numbers less than 127, excluding the fol-
lowing characters: \ / : * ? “ < > |
• Names cannot be longer than 48 characters
• A path cannot be longer than 126 characters (filename 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 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 segments:
• Deleting, moving or renaming a file or directory
• Writing or appending data to an existing file
• Formatting the file system
3.7.3 System Files
The file system contains a set of files used for system configuration. These files, known as “sys-
tem files”, are regular ASCII files which can be altered using a standard text editor (such as the
Notepad in Microsoft Windows™). The format of these files are, with some exceptions, based on
the concept of keys, where each key can be assigned a value, see below.
Example 1:
[Key1]
value of Key1
[Key2]
value of Key2
Anybus®CompactCom™40 Common Ethernet Design Guide HMSI-27–269 2.1

Firmware Download / Firmware Upgrade 14 (104)
4 Firmware Download / Firmware Upgrade
Download and upgrade of network communication firmware for a specific industrial Ethernet
network can be performed in different ways.
4.1 Using Firmware Manager II
This tool is available without cost from the HMS Industrial Networks AB support website, www.
anybus.com/support. It can be used to download new firmware or firmware upgrades for all
Anybus CompactCom modules.
Fig. 3
Using the tool, perform the following steps to download new firmware to the module.
1. Connect a computer with the Firmware Manager II software installed to the network con-
taining the module.
2. Start the Firmware Manager II tool.
3. Scan the network and 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 Firmware Reposi tory window.
5. In the scan window, under the “Available Networks” tab, select the appropriate firmware for
the module. Click the “Change Network” button. A confirmation window will appear. Click-
ing “Yes” will start the download of the new firmware.
6. After download, a restart of the module is needed to install the new firmware. If the applica-
tion allows it, it is possible to restart the module via the “Restart Module” button in the Firm-
ware Manager II tool. If the application does not allow restart from the network, a manual
restart of the module is needed.
For more information, see the help file in the Firmware Manager II software.
Anybus®CompactCom™40 Common Ethernet Design Guide HMSI-27–269 2.1

Firmware Download / Firmware Upgrade 15 (104)
4.2 Via the Internal File System
The internal file system of the module includes a directory (/firmware), where the new firmware
or the upgrade is stored. The file 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 is deleted from the /firmware directory.
See also...
•FTP Server, p. 16
•File System, p. 11
•Application File System Interface Object (EAh), p. 90
Anybus®CompactCom™40 Common Ethernet Design Guide HMSI-27–269 2.1

FTP Server 16 (104)
5 FTP Server
5.1 General Information
The built-in FTP-server makes it easy to manage the file system using a standard FTP client. It
can be disabled using attribute #6 in the Ethernet Host Object (F9h).
By default, the following port numbers are used for FTP communication:
• TCP, port 20 (FTP data port)
• TCP, port 21 (FTP command port)
The FTP server supports up to two concurrent clients.
5.2 User Accounts
User accounts are stored in the configuration file \ftp.cfg. This file holds the usernames, pass-
words, and home directory 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:PasswordN:HomedirectoryN
\path\userlistA:HomedirectoryA
\path\userlistB:HomedirectoryB
The files containing the user lists shall have the following format:
File Format:
User1:Password1
User2:Password2
User3:Password3
.
.
.UserN:PasswordN
Notes:
• Usernames must not exceed 16 characters in length.
• Passwords must not exceed 16 characters in length.
• Usernames and passwords must only contain alphanumeric characters.
Anybus®CompactCom™40 Common Ethernet Design Guide HMSI-27–269 2.1

FTP Server 17 (104)
• If \ftp.cfg is missing or cannot be interpreted, all username/password combinations will be
accepted and the home directory will be the FTP root (i.e. \ftp\).
• The home directory for a user must also exist in the file system, if the user shall be able to
log in. It is not enough just to add the user information to the ftp.cfg file.
• If Admin Mode has been enabled in the Ethernet Object, all username/password combina-
tions will be accepted and the user will have unrestricted access to the file system (i.e. the
home directory will be the system root). The vfs folder is read-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 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, type FTP://<user>:<password>@<address>
– - Substitute <address> with the IP address of the Anybus module
– - Substitute <user> with the username
– - Substitute <password> with the password
3. Press Enter. The Explorer will now attempt to connect to the Anybus module using the
specified settings. If successful, the file system will be displayed in the Explorer window.
Fig. 4
Anybus®CompactCom™40 Common Ethernet Design Guide HMSI-27–269 2.1

Web Server 18 (104)
6 Web Server
6.1 General Information
Category: extended
The built-in web server provides a flexible environment for end-user interaction and configura-
tion purposes. The powerful combination of JSON, SSI, and client-side scripting allows access
to objects and file system data, enabling the creation of advanced graphical user interfaces.
The web interface is stored in the file system, which can be accessed through the FTP server. If
necessary, the web server can be completely disabled in the Ethernet Host Object.
The web server supports up to TBD concurrent connections and communicates through port 80.
See also...
•FTP Server, p. 16
•JSON, p. 45
•Server Side Include (SSI), p. 25
•Ethernet Host Object (F9h), p. 91
6.2 Default Web Pages
The default web pages provide 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 folder, making it
appear as the files are located in the web root folder. By loading files in the web root folder with
exactly the same names as the default files in the vfs folder, it is possible to customize the web
pages, replacing such as pictures, logos and style sheets.
If a complete customized web system is designed and no files in the vfs folder are to be used, it
is recommended to turn off the virtual file system completely, see the File System Interface
Object.
See also...
•File System, p. 11
•Anybus File System Interface Object (0Ah), p. 87
Anybus®CompactCom™40 Common Ethernet Design Guide HMSI-27–269 2.1