CT - SM-Ethernet User Guide

User Guide
SM-Ethernet
Solutions Module for: Unidrive SP Commander SK Digitax ST Mentor MP Affinity
Part Number: 0471-0047-06 Issue: 6
www.controltechniques.com
General Information The manufacturer accepts no liability for any consequences resulting from inappropriate, negligent or incorrect installation or adjustment of the optional parameters of the equipment or from mismatching the variable speed drive with the motor. The contents of this guide are believed to be correct at the time of printing. In the interests of commitment to a policy of continuous development and improvement, the manufacturer reserves the right to change the specification of the product or its performance, or the content of the guide without notice. All rights reserved. No parts of this guide may be reproduced or transmitted in any form or by any means, electrical or mechanical including, photocopying, recording or by an information storage or retrieval system, without permission in writing from the publisher. Environmental Statement Control Techniques is committed to minimising the environmental impacts of its manufacturing operations and of its products throughout their life cycle. To this end, we operate an Environmental Management System (EMS) which is certified to the International Standard ISO 14001. Further information on the EMS, our Environment Policy and other relevant information is available on request, or can be found at www.greendrives.com. The electronic variable speed drives manufactured by Control Techniques have the potential to save energy and (through increased machine/process efficiency) reduce raw material consumption and scrap throughout their long working lifetime. In typical applications, these positive environmental effects far outweigh the negative impacts of product manufacture and end-of-life disposal. Nevertheless, when the products eventually reach the end of their useful life, they must not be discarded but should instead be recycled by a specialist recycler of electronic equipment. Recyclers will find the products easy to dismantle into their major component parts for efficient recycling. Many parts snap together and can be separated without the use of tools, while other parts are secured with conventional fasteners. Virtually all parts of the product are suitable for recycling. Product packaging is of good quality and can be re-used. Large products are packed in wooden crates, while smaller products come in strong cardboard cartons which themselves have a high-recycled fibre content. If not re-used, these containers can be recycled. Polythene, used on the protective film and bags from wrapping product, can be recycled in the same way. Control Techniques' packaging strategy prefers easily recyclable materials of low environmental impact, and regular reviews identify opportunities for improvement. When preparing to recycle or dispose of any product or packaging, please observe local legislation and best practice. Software Statement This Solutions Module (SM) is supplied with the latest software version. When retro-fitting to an existing system, all software versions should be verified to confirm the same functionality as Solutions Modules of the same type already present. This also applies to products returned from a Control Techniques Service Centre or Repair Centre. If there is any doubt please contact the supplier of the product. The software version of the Solutions Module can be identified by looking at Pr MM.02 and Pr MM.51, where MM is the relevant menu number for the Solutions Module slot being used. See Pr MM.02 and Pr MM.51 description later in this manual for more information. The software version takes the form of xx.yy.zz, where Pr MM.02 displays xx.yy and Pr MM.51 displays zz (e.g. for software version 01.01.00 Pr MM.02 will display 1.01 and Pr MM.51 will display 0). REACH legislation
EC Regulation 1907/2006 on the Registration, Evaluation, Authorisation and restriction of Chemicals (REACH) requires the supplier of an article to inform the recipient if it contains more than a specified proportion of any substance which is considered by the European Chemicals Agency (ECHA) to be a Substance of Very High Concern (SVHC) and is therefore listed by them as a candidate for compulsory authorisation. For current information on how this requirement applies in relation to specific Control Techniques products, please approach your usual contact in the first instance. Control Techniques position statement can be viewed at: http://www.controltechniques.com/REACH Copyright Issue : March 2009 Control Techniques Ltd. :6
Contents
1
1.1 1.2 1.3 1.4 1.5 1.6 1.7 1.8
Safety information .................................................................... 5

Warnings, cautions and notes ........................................................................ 5 Electrical safety - general warning .................................................................. 5 System design and safety of personnel .......................................................... 5 Environmental limits ....................................................................................... 6 Compliance with regulations ........................................................................... 6 Motor .............................................................................................................. 6 Adjusting parameters ...................................................................................... 6 General safety considerations for remote operation ....................................... 7
2
2.1 2.2 2.3 2.4
Introduction .............................................................................. 8
Features ......................................................................................................... 8 Solutions Module identification ....................................................................... 9 Product conformance ..................................................................................... 9 Conventions used in this guide ..................................................................... 10
3
3.1
Mechanical installation .......................................................... 11

General installation ....................................................................................... 11
4
4.1 4.2 4.3 4.4 4.5 4.6 4.7 4.8 4.9
Electrical installation ............................................................. 12

SM-Ethernet module information .................................................................. 12 Cabling considerations ................................................................................. 13 Module grounding ......................................................................................... 13 SM-Ethernet cable shield connections ......................................................... 13 Cable ............................................................................................................ 13 Maximum network length .............................................................................. 13 Minimum node to node cable length ............................................................. 14 Network topology .......................................................................................... 14 Typical network connections ........................................................................ 15
5
5.1 5.2 5.3 5.4 5.5 5.6 5.7 5.8 5.9 5.10 5.11 5.12 5.13 5.14 5.15 5.16 5.17 5.18 5.19
Getting started ........................................................................ 17

Minimum software versions required for Ethernet ........................................ 17 Network design considerations ..................................................................... 17 Addressing .................................................................................................... 17 Where do IP addresses come from? ............................................................ 17 Addressing etiquette ..................................................................................... 18 Class types ................................................................................................... 18 Generating the complete address ................................................................ 19 DHCP considerations ................................................................................... 20 Basic principles of routing ............................................................................. 20 Set-up flow chart ........................................................................................... 21 Setting the IP address .................................................................................. 22 Setting the subnet mask ............................................................................... 23 Setting the default gateway .......................................................................... 24 SM-Ethernet baud rate ................................................................................. 25 DHCP (Dynamic Host Configuration Protocol) ............................................. 25 SM-Ethernet operating status ....................................................................... 26 Re-initialising SM-Ethernet ........................................................................... 26 Re-initialise all Solutions Modules ................................................................ 26 Saving parameters to the drive ..................................................................... 27
SM-Ethernet User Guide Issue: 6
6
6.1 6.2 6.3 6.4 6.5 6.6 6.7
Protocols ................................................................................. 28
PC/PLC considerations ................................................................................ 28 Modbus TCP/IP ............................................................................................ 28 Web pages (HTTP) ....................................................................................... 29 FTP ............................................................................................................... 29 SMTP (email) ................................................................................................ 29 SNTP (clock synchronisation) ...................................................................... 29 EtherNet/IP ................................................................................................... 30
7
7.1 7.2
Web page basics .................................................................... 66

Connecting to SM-Ethernet .......................................................................... 66 Web page menu structure ............................................................................ 67
8
8.1 8.2 8.3 8.4 8.5 8.6
FTP/custom pages ................................................................. 73

Introduction ................................................................................................... 73 Managing files .............................................................................................. 73 Connections using FTP ................................................................................ 73 Custom files .................................................................................................. 74 Generating your own pages ......................................................................... 75 Understanding custom pages ....................................................................... 75
9
9.1 9.2 9.3 9.4 9.5 9.6
Applications ............................................................................ 77
Minimum software versions required for Ethernet ........................................ 77 CTSoft .......................................................................................................... 77 CTScope ....................................................................................................... 80 SyPTPro ....................................................................................................... 80 SyPTLite ....................................................................................................... 84 OPC server ................................................................................................... 84
10
10.1 10.2 10.3 10.4 10.5 10.6
Security ................................................................................... 85
Introduction ................................................................................................... 85 General site security issues .......................................................................... 85 Default restrictions ........................................................................................ 85 Account management ................................................................................... 86 Adding new accounts ................................................................................... 86 Security levels .............................................................................................. 87
11
11.1 11.2 11.3 11.4 11.5
Diagnostics ............................................................................. 88
LED diagnostics ............................................................................................ 88 Diagnostic flow chart .................................................................................... 89 Module identification parameters .................................................................. 90 Network configuration parameters ................................................................ 91 Diagnostic parameters .................................................................................. 97
12
12.1 12.2 12.3 12.4 12.5 12.6 12.7
Advanced features ............................................................... 101

Email configuration ..................................................................................... 101 Scheduled events ....................................................................................... 102 Updating and backup .................................................................................. 103 Advanced parameters ................................................................................ 104 Modbus TCP/IP (CT implementation) ......................................................... 108 Supported Modbus function codes ............................................................. 110 Modbus exception codes ............................................................................ 114
13
13.1
Quick reference .................................................................... 115

Complete parameter reference ................................................................... 115
14
Glossary of terms ................................................................. 121
Index ............................................................................125
Safety Mechanical Introduction information installation
1
1.1
Safety information
Warnings, cautions and notes
A Warning contains information, which is essential for avoiding a safety hazard.
WARNING
Electrical installation
A Caution contains information, which is necessary for avoiding a risk of damage to the product or other equipment.
CAUTION
Getting started
NOTE
A Note contains information, which helps to ensure correct operation of the product.
1.2
Electrical safety - general warning

The voltages used in the drive can cause severe electrical shock and/or burns, and could be lethal. Extreme care is necessary at all times when working with or adjacent to the drive. Specific warnings are given at the relevant places in this User Guide.
Protocols Web page FTP/custom Applications basics pages
1.3
System design and safety of personnel

The drive is intended as a component for professional incorporation into complete equipment or a system. If installed incorrectly, the drive may present a safety hazard. The drive uses high voltages and currents, carries a high level of stored electrical energy, and is used to control equipment which can cause injury. Close attention is required to the electrical installation and the system design to avoid hazards, either in normal operation or in the event of equipment malfunction. System design, installation, start up and maintenance must be carried out by personnel who have the necessary training and experience. They must read this safety information and this User Guide carefully. The STOP and SECURE DISABLE / SAFE TORQUE OFF functions of the drive do not isolate dangerous voltages from the output of the drive or from any external option unit. The supply must be disconnected by an approved electrical isolation device before gaining access to the electrical connections. With the sole exception of the SECURE DISABLE / SAFE TORQUE OFF function, none of the drive functions must be used to ensure safety of personnel, i.e. they must not be used for safety-related functions. The SECURE DISABLE / SAFE TORQUE OFF function is only available as standard on the Unidrive SP / Digitax ST. The SECURE DISABLE function on Unidrive SP and the SAFE TORQUE OFF function on Digitax ST meet the requirements of EN954-1 category 3 for the prevention of unexpected starting of the drive. They may be used in a safety-related application. The system designer is responsible for ensuring that the complete system is safe and designed correctly according to the relevant safety standards.
Security Diagnostics Advanced features Quick reference Glossary of terms Index
Careful consideration must be given to the functions of the drive which might result in a hazard, either through their intended behavior or through incorrect operation due to a fault. In any application where a malfunction of the drive or its control system could lead to or allow damage, loss or injury, a risk analysis must be carried out, and where necessary, further measures taken to reduce the risk - for example, an over-speed protection device in case of failure of the speed control, or a fail-safe mechanical brake in case of loss of motor braking.
1.4
Environmental limits
Instructions regarding transport, storage, installation and use of the drive must be complied with, including the specified environmental limits. Drives must not be subjected to excessive physical force. For more information on these limits see the relevant drive user guide.
1.5
Compliance with regulations

The installer is responsible for complying with all relevant regulations, such as national wiring regulations, accident prevention regulations and electromagnetic compatibility (EMC) regulations. Particular attention must be given to the cross-sectional areas of conductors, the selection of fuses or other protection, and protective earth (ground) connections. For instructions in achieving compliance with specific EMC standards, please refer to the relevant drive user guide. Within the European Union, all machinery in which this product is used must comply with the following directives: 98/37/EC: Safety of machinery. 89/336/EEC: Electromagnetic Compatibility.
1.6
Motor
Ensure the motor is installed in accordance with the manufacturers recommendations. Ensure the motor shaft is not exposed. Standard squirrel cage induction motors are designed for single speed operation. If it is intended to use the capability of the drive to run a motor at speeds above its designed maximum, it is strongly recommended that the manufacturer is consulted first. Low speeds may cause the motor to overheat because the cooling fan becomes less effective. The motor should be installed with a protection thermistor. If necessary, an electric forced vent fan should be used. The values of the motor parameters set in the drive affect the protection of the motor. The default values in the drive should not be relied upon. It is essential that the correct value is entered in the motor rated current parameter, Pr 0.46 for Unidrive SP, Affinity and Digitax ST, Pr 0.06 in Commander SK and Pr 0.28 in Mentor MP. This affects the thermal protection of the motor.
1.7
Adjusting parameters
Some parameters have a profound effect on the operation of the drive. They must not be altered without careful consideration of the impact on the controlled system. Measures must be taken to prevent unwanted changes due to error or tampering especially if a remote user can access the drive over Ethernet.
1.8
General safety considerations for remote operation

SM-Ethernet enables the possibility of remotely controlling a machine from a distance. It is vital that when connecting to a machine remotely, adequate safety procedures are implemented to prevent damage to the machine or injury to personnel. Any connection to a live system has the possibility of altering the state of the machine, adequate procedures must be implemented to cover this situation. It is the responsibility of the machine builder to ensure that such a system is safe and complies with current legislation.
Safety Mechanical Introduction information installation Electrical installation Getting started Protocols Web page FTP/custom Applications basics pages Security Diagnostics Advanced features Quick reference Glossary of terms Index
2
2.1
Introduction
Features
The SM-Ethernet is a Solutions Module that can be used on the following products to provide Ethernet slave connectivity: Unidrive SP Commander SK Affinity Digitax ST Mentor MP With the exception of Commander SK, it is possible to use more than one SM-Ethernet module or a combination of SM-Ethernet and other Solutions Modules to add additional functionality such as extended I/O, gateway functionality, or additional PLC features. The following list gives an overview of the functionality available within SM-Ethernet. Single RJ45 connectivity with support for shielded twisted pair. 10/100Mbs Ethernet with auto-negotiation. Full and half duplex operation with auto-negotiation. Auto crossover detection. TCP/IP. Modbus TCP/IP. EtherNet/IP. Embedded web pages for configuration. Event driven E-mail generation. SyPTPro over Ethernet. OPC server over Ethernet. CTSoft over Ethernet. Static IP configuration or DHCP client. SMTP. SNTP. Firmware updates over Ethernet using web pages. User defined web pages. Integrated security. 4kV impulse isolation. Help files integrated into the module. Multiple language support.
SM-Ethernet is powered from the host drives internal power supply and draws 280mA from the supply.
2.1.1
Backup/auxiliary supply
Unidrive SP, Affinity and Digitax ST drives provide a method of powering up the control circuits (and therefore any Solutions Modules installed) if the AC supply is removed, this allows the SM-Ethernet to continue operating when the main AC supply is switched off. For every SM-Ethernet module installed allow for an extra 280mA of supply current to be drawn from the backup supply.
2.2
Solutions Module identification

Figure 2-1 SM-Ethernet
Safety Mechanical Electrical Introduction information installation installation Getting started
The SM-Ethernet can be identified by: 1. The label located on the underside of the Solutions Module. Figure 2-2 SM-Ethernet label
Solutions Module name
SM-Ethernet
Hardware issue number
Issue: 2.00 STDJ41
Customer and date code Serial number
Ser No : 3000005001
2. The color coding across the front of the Solutions Module. SM-Ethernet being beige.
2.2.1
Date code format

The date code is split into two sections: a letter followed by a number. (see Figure 22 SM-Ethernet label on page 9) The letter indicates the year, and the number indicates the week number (within the year) in which the Solutions Module was built. The letters go in alphabetical order, starting with A in 1990 (B in 1991, C in 1992 etc.). Example: A date code of R35 would correspond to week 35 of year 2008.
Security Diagnostics Advanced features
2.3
Product conformance
SM-Ethernet complies with IEEE 802.3 and meets the isolation requirements of safety standard EN50178.
Quick reference Glossary of terms Index
2.4
Conventions used in this guide

The configuration of the host drive and Solutions Module is done using menus and parameters. A menu is a logical collection of parameters that have similar functionality. In the case of a Solutions Module, the parameters will appear in one of three menus 15, 16 or 17 depending on the drive type and slot the module is installed into as shown in Table 2.1 Drive menu availability below. The menu is denoted by the number before the decimal point. The method used to determine the menu or parameter is as follows: Pr xx.00 - signifies any menu and parameter number 00. Pr MM.xx - where MM signifies the menu allocated to the solutions module (as shown in Table 2.1 Drive menu availability ) and xx signifies the parameter number.
Table 2.1 Drive menu availability

Drive Type Unidrive SP Affinity Mentor MP Commander SK Digitax ST Slot 1 15.xx Yes Yes Yes Yes Yes Slot 2 16.xx Yes Yes Yes No Yes Slot 3 17.xx Yes No Yes No No
10
Safety Mechanical Electrical Introduction information installation installation
Mechanical installation
Before installing or removing a Solutions Module in any drive, ensure the AC supply has been disconnected for at least 10 minutes and refer to Chapter 1 Safety information on page 5. If using a DC bus supply ensure this is fully discharged before working on any drive or Solutions Module.
WARNING
3.1
General installation
The installation of a Solutions Module is illustrated in Figure 3-1. Figure 3-1 Fitting a Solutions Module
1
Getting started
Protocols Web page FTP/custom Applications basics pages Security Diagnostics Advanced features Quick reference Glossary of terms Index
The Solutions Module connector is located on the underside of the module (1). Push this into the Solutions Module slot located on the drive until it clicks into place (2). Note that some drives require a protective tab to be removed from the Solutions Module slot. For further information, refer to the appropriate drive manual.
11
4
4.1
Electrical installation
SM-Ethernet module information
SM-Ethernet provides a standard RJ45 UTP/STP (Un-shielded/Shielded Twisted Pair) connection to a 10Mbs or 100Mbs Ethernet system. In addition to the RJ45 connector a grounding tag is supplied for supplementary bonding. SM-Ethernet provides 4 diagnostic LEDs for status and information purposes. Figure 4-1 SM-Ethernet terminals
Figure 4-1 shows an overview of the module connections and indicators. The default mode for the RJ45 is crossover. Figure 4-2 SM-Ethernet Module Layout
Spade connector
Link / Activity 8 7 6 5 4 3 2 1 Speed (On = 100Mbs)
Module status Flash access
Not used Not used Receive Not used
Transmit + Transmit Receive + Not used
Table 4.1 RJ45 pin out details

RJ45 Terminal 1 2 3 4 5 6 7 8 Internal Crossover Disabled (Pr MM.43=0) Transmit +Ve Transmit -Ve Receive +Ve Receive -Ve Internal Crossover Enabled (Pr MM.43=1) Receive +Ve Receive -Ve Transmit +Ve Transmit -Ve -
12
4.2
Cabling considerations
To ensure long-term reliability it is recommended that any cables used to connect a system together are tested using a suitable Ethernet cable tester, this is of particular importance when cables are constructed on site.
4.3
Module grounding
SM-Ethernet is supplied with a grounding tag on the module that should be connected to the closest possible grounding point using the minimum length of cable. This will greatly improve the noise immunity of the module.
4.4 4.5
SM-Ethernet cable shield connections

Standard Ethernet UTP or STP cables do not require supplementary grounding.
Cable
It is recommended that a minimum specification of CAT5e is installed on new installations, as this gives a good cost/performance ratio. If you are using existing cabling this may limit the maximum data rate depending on the cable ratings. In noisy environments the use of STP or fiber optic cable will offer additional noise immunity.
Getting started Protocols
NOTE
Cabling issues are the single biggest cause of network down-time. Ensure cabling is correctly routed, wiring is correct, connectors are correctly installed and any switches or routers used are rated for industrial use. Office grade Ethernet equipment does not generally offer the same degree of noise immunity as equipment intended for industrial use.
Web page FTP/custom Applications basics pages
4.6
Maximum network length

The main restriction imposed on Ethernet cabling is the length of a single segment of cable as detailed in Table 4.2. If distances greater than this are required it may be possible to extend the network with additional switches or by using a fiber optic converter. Table 4.2 Ethernet maximum network lengths
Type Of Cable Copper - UTP/STP CAT 5 Copper - UTP/STP CAT 5 fiber Optic - Multi-mode fiber Optic - Multi-mode fiber Optic - Single-mode fiber Optic - Single-mode Data rate (bit/s) 10M 100M 10M 100M 10M 100M Maximum trunk length (m) 100 100 2000 3000 no standard up to 100000
Security Diagnostics Advanced features Quick reference
NOTE
The distances specified are absolute recommended maximums for reliable transmission of data. The distances for the fiber optic sections will be dependent on the equipment used on the network. The use of wireless networking products is not recommended for control systems, as performance may be affected by many external influences.
Glossary of terms Index
13
4.7
Minimum node to node cable length

There is no minimum length of cable recommended in the Ethernet standards for UTP or STP. For consistency across fieldbus modules, Control Techniques recommends a minimum network device to device distance of 1 metre of cable. This minimum length helps to ensure good bend radii on cables and avoids unnecessary strain on connectors.
4.8
4.8.1
Network topology
Hubs
A hub provides a basic connection between network devices. Each device is connected to one port on the hub. Any data sent by a device is then sent to all ports on the hub. The use of hubs is not recommended for use within control systems due to the increased possibility of collisions. Collisions can cause delays in data transmission and are best avoided, in severe cases a single node can prevent other nodes on the same hub (or collision domain) from accessing the network. If using hubs or repeaters you must ensure that the path variability value and propagation equivalent values are checked. This is, however, beyond the scope of this document.
NOTE
Control Techniques do not recommend the use of un-switched hubs.
4.8.2
Switches
Switches offer a better solution to hubs, because after initially learning the addresses of connected devices the switch will only send data to the port that has the addressed device connected to it, thus reducing network traffic and possible collisions. The difference in price between the hub and a switch means that in almost all cases the switch is the preferred choice. Some managed switches allow the switching of data to be controlled and monitored, this may be of particular importance on large or high performance systems.
NOTE
Some switches require a certain time to intitialise (typically 30 to 60 seconds) if SMEthernet is reset.
4.8.3
Routers
A router is used to communicate between two physical networks (or subnets) and provides some degree of security by allowing only defined connections between the two networks. A typical use would be connecting the office and manufacturing networks or connecting a network to an ISP (Internet Service Provider). A router is sometimes known as a gateway as it provides a gateway between two networks. It is generally recommended that a firewall is used when connecting networks as this provides additional security features.
4.8.4
Firewalls
A firewall allows separate networks to be connected together in a similar way to a router. The firewall however offers significantly more security features and control. Typical features include address translation, port filtering, protocol filtering, URL filtering, port mapping, service attack prevention, monitoring and virus scanning. This is usually the preferred method of allowing traffic from a manufacturing network to the business network. The setup and installation of the firewall should be done by a suitably qualified engineer and is beyond the scope of this document.
14
4.8.5
VPN
A VPN (Virtual Private Network) is a method of using a non-secure or public network that allows devices to be connected together as if they were connected on a private network. A typical example would be the connection of two remote offices such as London and New York. Each office would require a high speed Internet connection and a firewall (or VPN device). In order to configure the VPN, encryption keys are exchanged so that both offices can communicate. The data is then sent across the Internet (or shared network) in an encrypted form, giving the illusion of a single connected network (speed limitations may apply). This is generally used as a low-cost alternative to a private leased line. Configuration of VPNs is beyond the scope of the document.
4.9
4.9.1
Typical network connections

Single PC to SM-Ethernet
To connect a PC to the SM-Ethernet using the default setting of Pr MM.43 requires a crossover cable. This allows the two devices to communicate without the need to change any settings on SM-Ethernet or the use of a switch or hub. Figure 4-3 Connecting a single PC to SM-Ethernet using a crossover cable
Getting started Protocols Web page FTP/custom Applications basics pages Security
cross over cable
Diagnostics
NOTE
When purchasing network cables it is recommended that a different color (e.g. pink) is used for crossover cables to allow easy recognition. When connecting as in Figure 4-3, to avoid the need for crossover cables it is possible to change the SM-Ethernet RJ45 port to use a non-crossover cable by setting Pr MM.43 to 1. This will force SM-Ethernet to detect the type of cable used when it initialises allowing either type to be used. If autodetect is disabled (Pr MM.43=0) a cross-over cable is needed or you need to connect via a switch. For more information see SM-Ethernet enable auto-crossover detection on page 95. Some PCs and network switches provide auto-crossover correction and therefore the need for a crossover cable may not be necessary. Refer to the PC or network switch documentation for confirmation.
Advanced features Quick reference Glossary of terms
NOTE
Index
15
4.9.2
Single PC to multiple SM-Ethernet using a single switch

Connecting multiple SM-Ethernet modules should be done using an industrial grade switch. Each SM-Ethernet or PC is connected to the switch using a standard RJ45 lead (patch lead). Figure 4-4 Single PC to multiple SM-Ethernet modules using a switch
Non-crossover cable Switch Non-crossover cable
4.9.3
Single PC to multiple SM-Ethernet using more than one switch

When using more than one switch, ensure that the cables connecting the switches are of the correct type. This will normally be a crossover cable, unless the switch supports auto crossover correction or has a switch to convert the socket, if this is the case a noncrossover lead may be used. Please consult the documentation supplied with the switch for more information. Figure 4-5 Connections with multiple switches
Non-crossover cables Switch
Non-crossover cable or crossover cable (check device documentation)
Non-crossover cables
Switch
4.9.4
Connection of network subnets

When connecting multiple network subnets a router or firewall should be used to allow effective management of network traffic. A subnet is identified by the change in the network section of the IP address (see section 5.7.1 The IP address on page 19 for more information). A subnet boundary is usually designated by a router or firewall. The design of larger networks, however, is beyond the scope of this document.
16
5
5.1
Getting started
Minimum software versions required for Ethernet
Table 5.1 below, lists the minimum versions of software required for Ethernet communication. Table 5.1 Required software versions for communication over Ethernet
Product Unidrive SP Commander SK Digitax ST Affinity Mentor MP SM-Applications SM-Ethernet OPC Server CTScope SyPTPro CTSoft Software Version Version 01.06.00 or later Version 01.06.00 or later Version 01.00.00 or later Version 01.00.00 or later Version 01.00.00 or later Version 01.04.05 or later Version 01.02.00 or later Version 03.01.00 or later Version 01.00.00 or later Version 02.01.00 or later Version 01.05.00 or later
Getting started Protocols Web page FTP/custom Applications basics pages
5.2
Network design considerations

Ethernet is an open system allowing many different vendors to design and supply equipment. When designing an industrial network you must carefully consider the topology and data traffic on the network to avoid potential problems. To avoid bandwidth issues it is recommended that the control network is logically separate from any other network. Where possible a physically separate network should be used. If this is not possible, the use of managed network devices should be considered to prevent unnecessary traffic such as broadcasts reaching the control network.
Security
NOTE
The use of un-switched hubs is not recommended.
Diagnostics
5.3
Addressing
The addressing system used on Ethernet uses two essential numbers for making connection, these are the IP address and the subnet mask. The address allows a specific device to be located and the subnet mask defines how many bits represent the subnet part of the address and how many bits represent the node address (see section 5.7.1 The IP address on page 19). Generally devices on different subnets can only communicate by using a gateway (typically a router or firewall).
Advanced features Quick reference
5.4
Where do IP addresses come from?

Every address on a network must be unique. If you do not connect your network to any other networks the assignment of IP addresses is not critical (although using a standard system is recommended), as you have full control of the addresses used. The issue of addressing becomes important when connecting multiple networks together or connecting to the Internet where there is a strong possibility of duplication of addresses if a scheme is not followed.
17
5.5
Addressing etiquette
The following list details some points that should be considered when selecting addresses: Reserve address space: Ensure you have enough reserve address space on your chosen addressing scheme to allow for future expansion. Uniqueness: Ensure your addresses are unique, every device on a subnet must have a unique address. Avoid reserved addresses: For example the address 127.0.0.1 is reserved as the loop back address. Broadcast and system addresses: The highest and lowest host address on a subnet are reserve addresses. Use a system: Have a scheme for assigning your addresses, for example typically servers may have a low IP address and routers a high IP address. It is not necessary to allocate consecutive IP addresses so it is possible to reserve ranges for specific uses such as servers, work stations or routers.
5.6
Class types
IP addresses are grouped into ranges called classes, each class has a specific set of addresses and has a typical situation where it is used. When selecting the class of IP address required, consideration must be given to how many subnets you need, how many hosts are required and if you will need a public (worldwide) or a private (local) addressing scheme. Table 5.2 shows an overview of how the class types are defined and Table 5.3 shows how each class separates the subnet and host ID. Table 5.2 Subnets and hosts supported by class type
Address Class A B C First Octet Decimal Range 1-126.x.y.z 128-191.x.y.z 192-223.x.y.z Number of Subnets 126 16,382 2,097,150 Number of Hosts 16,777,214 65,534 254
Table 5.3 Address components

Address Class A B C
NOTE
IP Address w.x.y.z w.x.y.z w.x.y.z
Subnet Host Component Component w w.x w.x.y x.y.z y.z z
Using the subnet mask it is possible to modify the IP addressing such that the ratio of subnets and host addresses may be changed. This gives you the facility to adjust standard classes to suit your specific requirements.
18
5.6.1
Class A addresses
A class A address only uses the first octet to represent the subnet, the remaining octets are used to represent the host id. These addresses are intended for large organisations such as universities and the military. These addresses must be requested from the governing body (InterNIC) when using them publicly (on the Internet) to avoid duplication.
5.6.2
Class B addresses
A class B address uses the first two octets to represent the subnet, the remaining octets are used to represent the host id. These addresses are intended for medium to large size networks. These addresses must be requested from the governing body (InterNIC) when using them publicly (on the Internet) to avoid duplication. Class B addresses are generally used on public or private networks.
5.6.3
Class C addresses
Class C addresses use the first 3 octets as the subnet address and the remaining octet as the host id. A class C address is normally used on a private network only, due to the restriction on the number of hosts on the network. Class C addresses will not be routed onto the Internet.
5.6.4
Class D & E addresses

These addresses are reserved for multicasting and experimental use.
5.7
Generating the complete address

A complete IP address consists of an IP address and a subnet mask, these two numbers are required to allow communication on Ethernet using TCP/IP.
5.7.1
The IP address
The IP address is made up from four 8 bit decimal numbers (octets) and is written as follows: w.x.y.z for example192.168.0.1 (class c)
Security
5.7.2
The subnet mask

The subnet mask defines what part of the address constitutes the subnet within the IP address and what part of the address constitutes the host address. The subnet mask is bit-wise ANDed with the address to give the subnet to which the host belongs. A typical class C subnet mask would be 255.255.255.0, this may alternatively be written as /24 as in the example below, showing an IP address of 192.168.0.1 with a subnet mask of 255.255.255.0. This alternative notation indicates the number of bits representing the subnet part of the address, starting from the most significant bit. Alternative subnet mask notation: 192.168.0.1 /24
Diagnostics Advanced features Quick reference
5.7.3
Completing the address

To determine which part of the address constitutes the network address and which part constitutes the node address, the IP address is bit-wise ANDed with the subnet mask. Figure 5-1 shows how the IP address and subnet mask are used to determine the subnet address and the host address.
19
Figure 5-1 Completing the address

w IP Address 192 x 168 y 0 z 1 bit-wise AND w Subnet Mask 255 x 255 y 255 z 0
w Subnet Address 192
x 168
y 0
z 0 Host Address
5.8
5.8.1
DHCP considerations
Using fixed IP addressing
Using fixed IP addresses (manually configured) on SM-Ethernet means that if a module fails, the IP address can be restored to a replacement module without the need to reconfigure the DHCP server. Using fixed addresses also prevents the DHCP server from changing the address. When using fixed IP addresses, it is vital that the SMEthernet IP address is reserved on the DHCP server to prevent duplicate addressing.
NOTE
If using manual IP address configuration please note that the IP address subnet mask and the default gateway must also be set manually. For more information on manual configuration see section 7.2.6 Network on page 72.
5.8.2
Using DHCP
If DHCP is used it is recommended that the allocated IP address is allocated SMEthernets MAC address, this strategy prevents the IP address changing on the SMEthernet. Any leased addresses should be leased permanently to prevent IP address changes.
NOTE
If SM-Ethernet is configured to use DHCP and the module requires exchanging, the new SM-Ethernet module will have a different MAC address and hence the DHCP server will issue the new module with a different IP address.
5.9
Basic principles of routing

Routing is required to get TCP/IP packets from one subnet to another. In an IP network nodes from one subnet cannot communicate directly with nodes on a different subnet. To allow nodes to communicate, a router (or similar device) is required to allow the two subnets to exchange data. This means that any node wishing to communicate with a node that is not on its own subnet, must know the address of a router that is on its own subnet. This is sometimes called a gateway or default gateway.
20
5.10
Set-up flow chart

Start
Connect all drives together using approved cable / connectors / switches
See Chapter 4
PING all drives from a command prompt to test connections
See Chapter 5
Ensure each drive Is correctly grounded
See Chapter 4
Connect to each drive using a web browser
See Chapter 7
Getting started
Ensure segment lengths no longer than maximum limits.
See Chapter 4
Save module settings on drive.
See Chapter 5
Ensure that there are no circular loops between devices/switches
Note: Redundant systems require specialist hardware.
Configure additional features using a web browser
See Chapter 7
Ensure the correct cable types are used
END
See Chapter 4
Perform cable tests
A dedicated Ethernet cable tester Is recommended.
Security Diagnostics
Configure the IP address, subnet mask and default gateway
See Chapter 5
Any changes made will require a module reset to be activated Pr MM.32 = ON
Check data rate. (Pr MM.04)
See Chapter 5
Glossary of terms
Ensure PC is on the same subnet or the default gateway on the drive & PC are set
See Chapter 5
Index
21
5.11
Setting the IP address

The SM-Ethernet IP address is formed by taking the component parts of the address from parameters Pr MM.10 to Pr MM.13 and combining them as in Figure 5-2. The address is then used in conjunction with the subnet mask. Figure 5-2 The IP address
SM-Ethernet IP address
Wip
Pr MM.10
Xip
Pr MM.11
Yip
Pr MM.12
Zip
Pr MM.13
NOTE
When DHCP is enabled (see section 5.15 DHCP (Dynamic Host Configuration Protocol) on page 25) the whole IP address is acquired from the DHCP server and written to the parameters in the drive during start-up. This could take several minutes depending on server availability and network status.
5.11.1 SM-Ethernet IP address Wip

SM-Ethernet IP address Wip Default Pr MM.10 Range Access 192 0 to 255 RW
This is the most significant octet of SM-Ethernets IP address. When using DHCP this will be updated from the DHCP server.
5.11.2 SM-Ethernet IP address Xip

SM-Ethernet IP address Xip Default Pr MM.11 Range Access 168 0 to 255 RW
This is the second most significant octet of SM-Ethernets IP address. When using DHCP this will be updated from the DHCP server.
5.11.3 SM-Ethernet IP address Yip

SM-Ethernet IP address Yip Default Pr MM.12 Range Access 1 0 to 255 RW
This is the third most significant octet of SM-Ethernets IP address. When using DHCP this will be updated from the DHCP server.
5.11.4 SM-Ethernet IP address Zip

SM-Ethernet IP address Zip Default Pr MM.13 Range Access 100 0 to 255 RW
This is the least significant octet of SM-Ethernets IP address. When using DHCP this will be updated from the DHCP server.
22
5.12
Setting the subnet mask

The SM-Ethernet subnet mask is formed by taking the component parts of the subnet mask from parameters Pr MM.14 to Pr MM.17 and combining them as in Figure 5-3. The subnet mask is then used in conjunction with the IP address. Figure 5-3 The subnet mask
SM-Ethernet subnet mask

NOTE
Wsubnet Pr MM.14
Xsubnet Pr MM.15
Ysubnet Pr MM.16
Zsubnet Pr MM.17
When DHCP is enabled the whole subnet mask address is acquired from the DHCP server and written to the parameters in the drive during start-up. This could take several minutes depending on server availability and network status.
Getting started
5.12.1 SM-Ethernet IP subnet mask Wsubnet

SM-Ethernet IP subnet mask Wsubnet Default Pr MM.14 Range Access 255 0 to 255 RW
This is the most significant octet of SM-Ethernets IP subnet mask. When using DHCP this will be updated from the DHCP server.
5.12.2 SM-Ethernet IP subnet mask Xsubnet

SM-Ethernet IP address Xsubnet Default Pr MM.15 Range Access 255 0 to 255 RW
This is the second most significant octet of SM-Ethernets IP subnet mask. When using DHCP this will be updated from the DHCP server.
Security
5.12.3 SM-Ethernet IP subnet mask Ysubnet

SM-Ethernet IP subnet mask Ysubnet Default Pr MM.16 Range Access 255 0 to 255 RW
Diagnostics Advanced features
This is the third most significant octet of SM-Ethernets IP subnet mask. When using DHCP this will be updated from the DHCP server.
Quick reference
5.12.4 SM-Ethernet IP subnet mask Zsubnet

SM-Ethernet IP subnet mask Zsubnet Default Pr MM.17 Range Access 0 0 to 255 RW
Glossary of terms
This is the least significant octet of SM-Ethernets IP subnet mask. When using DHCP this will be updated from the DHCP server.
Index
23
5.13
Setting the default gateway

The SM-Ethernets default gateway is formed by taking the component parts of the default gateway from parameters Pr MM.18 to Pr MM.21 and combining them as in Figure 5-4. The default gateway is then used in conjunction with the IP address and subnet mask to locate hosts on different subnets. Figure 5-4 The default gateway
SM-Ethernet subnet mask
Wgateway Xgateway
Pr MM.18 Pr MM.19
Ygateway Zgateway
Pr MM.20 Pr MM.21
The default gateway is a routing device that allows a host to reach other devices that are not on the same subnet. The default gateway must be on the same subnet as the host that is trying to use it.
NOTE
When DHCP is enabled the whole default gateway address is acquired from the DHCP server and written to the parameters in the drive during start-up. This could take several minutes depending on server availability. When communication is performed through a gateway, the devices on both sides of the gateway must be configured to see their side of the gateway for communications to be established.
NOTE
5.13.1 SM-Ethernet IP default gateway Wgateway

SM-Ethernet IP default gateway Wgateway Default Pr MM.18 Range Access 192 0 to 255 RW
This is the most significant octet of SM-Ethernets default gateway address. When using DHCP this will be updated from the DHCP server.
5.13.2 SM-Ethernet IP default gateway Xgateway

SM-Ethernet IP default gateway Xgateway Default Pr MM.19 Range Access 168 0 to 255 RW
This is the second most significant octet of SM-Ethernets default gateway address. When using DHCP this will be updated from the DHCP server.
5.13.3 SM-Ethernet IP default gateway Ygateway

SM-Ethernet IP default gateway Ygateway Default Pr MM.20 Range Access 1 0 to 255 RW
This is the third most significant octet of SM-Ethernets default gateway address. When using DHCP this will be updated from the DHCP server.
24
5.13.4 SM-Ethernet IP default gateway Zgateway

SM-Ethernet IP default gateway Zgateway Default Pr MM.21 Range Access 254 0 to 255 RW
This is the least significant octet of SM-Ethernets default gateway address. When using DHCP this will be updated from the DHCP server.
5.14
SM-Ethernet baud rate

SM-Ethernet baud rate Default Pr MM.04 Range Access 0 0 to 2 RW
SM-Ethernet can be set to automatically detect the baud rate or be fixed at either 10Mbs or 100Mbs. Pr MM.44 will indicate the data rate that is being used by the SM-Ethernet. Table 5.4 SM-Ethernet baud rate
Pr MM.04 0 1 2 baud rate Auto detect 10Mbs 100Mbs
NOTE
This parameter should normally be left in the auto detect state.
5.15
DHCP (Dynamic Host Configuration Protocol)

DHCP enable Default Pr MM.05 Ranges Access 0 0 to 1 RW
5.15.1 DHCP enable
This parameter determines if the module gets its network configuration (IP address, subnet mask, etc.) from the host drive parameters or from a DHCP server on the network. The DHCP server can be configured to give the module the next free address or an address based on the MAC address of SM-Ethernet. Table 5.5 DHCP options
Pr MM.05 0 1 DHCP enable Use local configuration Use DHCP server
A DHCP server will typically provide SM-Ethernet with an IP address, subnet mask, default gateway and DNS information.
25
5.15.2 DHCP server configuration

When using DHCP it is possible that every time SM-Ethernet re-initialises it will receive a new IP address. This will make it difficult to keep track of what IP address is allocated to a particular module and when using a Modbus IP master this would also require reconfiguration. Control Techniques recommend that the leased IP address for SM-Ethernet is allocated to SM-Ethernets MAC address. This will prevent SM-Ethernets IP address changing when it re-initialises or when the DHCP server renews the SM-Ethernets lease.
5.16
SM-Ethernet operating status

SM-Ethernet operating status Default Pr MM.06 Range Access N/A -95 to 9999 RO
This parameter gives an approximation of the number of packets per second processed on SM-Ethernet, a value of zero indicates that SM-Ethernet is initialised and ready to communicate. If this parameter is a negative value this indicates that the module is initialising or there is a fault. If this value is still negative after 3 minutes see section 11.5.1 SM-Ethernet diagnostic information on page 97.
5.17
Re-initialising SM-Ethernet
Re-initialising SM-Ethernet Default Pr MM.32 Range Access OFF OFF / ON RW
Changes to the SM-Ethernet configuration will not take effect until the SM-Ethernet has been re-initialised. To re-initialise SM-Ethernet: 1. Set Pr MM.32 to ON. 2. Before the reset takes place Pr MM.32 will be reset to OFF. 3. The SM-Ethernet will re-initialise using the updated configuration.
NOTE
This sequence does NOT store the SM-Ethernet configuration parameters in the host drive or the SM-Ethernet FLASH memory. Pr MM.32 will revert to OFF immediately and may not be visible on the display.
5.18
Re-initialise all Solutions Modules

To re-initialise all Solutions Modules installed on a drive: 1. Set Pr MM.00 to 1070. (See note regarding Commander SK). 2. Press the red RESET button on the drive.
NOTE
This sequence does NOT store the SM-Ethernet configuration parameters in the drive or the SM-Ethernet FLASH memory. The 1070 reset will not work in the SM-Ethernet module if Pr MM.37 is set to ON, although it will work for any other modules. On Commander SK drives, Pr 00.00 is not available, a different menu number must be used, e.g. Pr 01.00. SM-Ethernet User Guide Issue: 6
NOTE
26
5.19
Saving parameters to the drive

To avoid loss of the configured settings when the drive is powered down it is necessary to write 1000 to Pr MM.00 and then press the reset button to perform a drive save. To store drive parameters: Set Pr MM.00 to 1000. (See notes). Press the red RESET button.
The drive will store all parameters (except Menu 20), but the operation of the SMEthernet will not be affected. Changes made to the SM-Ethernet configuration parameters will not take effect until the SM-Ethernet is re-initialised.
NOTE
Menu 20 may be saved in memory (not Commander SK) if an SM-Applications is installed. See the SM-APPLICATIONS/SM-APPLICATIONS LITE User Guide documentation for more information. If the host drive is running on a low voltage supply only or has a UU trip active the value 1001 must be used instead of 1000. On Commander SK drives, Pr 00.00 is not available, a different menu number must be used, e.g. Pr 01.00.
Getting started
NOTE
27
Protocols
SM-Ethernet supports a wide range of protocols for communicating over Ethernet, each protocol has a specific use and it is important to understand how to use each protocol before designing a system.
6.1
PC/PLC considerations
If the subnet of the host PC/PLC is different to the subnet of SM-Ethernet, then both SM-Ethernet and the PC/PLC must be configured with the address of a gateway that allows communication between the two devices.
6.2
Modbus TCP/IP
Modbus TCP/IP is one of the most widely supported industrial Ethernet based protocols offering the functionality and simplicity of the Modbus protocol, with the flexibility of Ethernet. Table 6.1 shows the supported Modbus function codes. The SM-Ethernet implementation of Modbus TCP/IP follows the specification provided by the Modbus organisation. Modbus TCP/IP uses the standard Protocol Data Unit (PDU) but without the CRC bytes and encapsulates it within a Modbus TCP/IP Application Data Unit (ADU) for transmission. This means that the Modbus PDU is the same for both standard and Ethernet based transmission. Table 6.1 Supported Modbus function codes
Code 3 6 16 23 Description Read multiple 16 bit registers. Write single 16 bit register. Write multiple 16 bit registers. Read and write multiple 16 bit registers.
Modbus TCP/IP port The port number used for Modbus TCP/IP may be reconfigured to a different port number using Pr 62.04 as detailed in Table 6.2 SM-Ethernet Modbus TCP/IP configuration . Table 6.2 SM-Ethernet Modbus TCP/IP configuration
SM-Ethernet Modbus TCP/IP configuration Default Pr 62.04 Range Access 502 0 to 65535 RW
A timer is available under the MODBUS IP configuration section of the web pages to allow loss of MODBUS communications to be managed (see Chapter 12 Advanced features on page 101 for more Modbus I/P options).
NOTE
Unidrive SP versions prior to V01.06.00 with SM-Ethernet versions after V01.01.00 are not capable of supporting CMP Port-ID 0. This will prevent communications to the drive, ensure the latest drive and SM-Ethernet firmware are used. The SM-Ethernet module must request control of the EIA-485 (RS-485) buffer to enable reliable communication in this mode. This is done by setting Pr MM.37 to ON.
NOTE
28
6.3
Web pages (HTTP)

Web page access is provided to allow configuration of the drive and Solutions Module(s). The web pages also allow parameters to be monitored and configuration settings to be uploaded or downloaded. In addition to the standard web pages it is possible to generate custom pages for displaying drive parameters for diagnostic or basic HMI (human machine interface) style displays. For more information on custom web pages please refer to Chapter 8 FTP/ custom pages on page 73. To view web pages on SM-Ethernet one of the following web browsers should be used: Microsoft Internet Explorer (version 5.0 or later). Netscape (version 6.0 or later). Mozilla (version 1 or later). Opera (version 8 or later).
The standard web pages provide access to the following features: Parameters. Protocol configuration. Network configuration. General configuration. Help pages providing guidance on use. System file updates for SM-Ethernet. Language support.
For details of the web pages please see Chapter 7 Web page basics on page 66.
6.4
FTP
FTP will allow custom web page changes on SM-Ethernet. If an appropriate network infrastructure exists it will be possible to perform these updates remotely. SM-Ethernet has a basic file system that will allow the user to upload files. The following facilities are supported: Web page languages Custom web pages
See Chapter 8 FTP/custom pages on page 73 for more details.
6.5
SMTP (email)
SM-Ethernet provides a method for sending Emails based on events. Up to 3 Email messages may be configured to transmit on a pre-defined condition. For more information on SMTP see section 12.1 Email configuration on page 101.
Advanced features
6.6
SNTP (clock synchronisation)

SNTP allows synchronisation of SM-Ethernets real-time clock with the time on a server. This time information can be written to parameters or can be used to trigger events specified in the 'Scheduled Events'. For more information on SNTP and scheduled events see section 12.2 Scheduled events on page 102.
29
6.7
EtherNet/IP
SM-Ethernet (v01.03.00 and later) supports the EtherNet/IP protocol and conforms to the EtherNet/IP adaptation of the Common Industrial Protocol (CIP) Specification. This is the same upper-layer protocol and object model as used in DeviceNet. The SM-Ethernet module will operate as a slave device and the following functionality is supported. Variable length input assembly object (instance 100). Variable length output assembly object (instance 101). Maximum assembly object size of 160 bytes (40 parameters). Explicit (non-cyclic) access to parameters. A.C. and D.C. Drive Profiles. Management of consistent data transfer between SM-Ethernet and SMApplications modules. Configuration via the web page interface.
6.7.1
Performance
The performance of EtherNet/IP will depend on several factors, including the data rate, EtherNet/IP thread priority and network traffic. If the EtherNet/IP thread is allocated a high priority and the network traffic is dominated by EtherNet/IP then the following performance should be achieved. Turn around time for polled (implicit) data of 2ms. Turn around time for non-cyclic (explicit) data of 5ms.
NOTE
Access to SM-Applications using the inter-option communication channel will extend these times. These network performance timings are not guaranteed and will vary depending on the network configuration. The performance values stated above will also be slower on Commander SK due to the hardware differences of the Commander SK.
NOTE
NOTE
6.7.2
Configuration
The EtherNet/IP configuration can be accessed from the top-level PROTOCOLS menu of the web page interface. From this page, the following general configuration settings can be viewed or changed. Connection status (view only). Advanced EDS file - disabled or enabled. Requested packet interval (RPI) timeout trip - disabled or enabled. Read consistency - disabled or enabled. Write consistency - disabled or enabled.
The cyclic (implicit) data parameter mapping configuration can also be changed from this page. For more information on cyclic data parameter mappings see section 6.7.10Configuring SM-Ethernet cyclic parameters on page 33.
NOTE
The user must be logged in as an Administrator or Super user to change the configuration settings.
30
6.7.3
Connection Status
This indicates if a cyclic (implicit) connection has been made and whether cyclic data transfer is in progress. If no cyclic connection has been made then the status will indicate Awaiting Connection, if a cyclic connection has been made then the status will indicate Connected.
6.7.4
Advanced EDS File

If the advanced EDS file is disabled, then the identity object will only contain the product code and revision number, if the advanced EDS file is enabled, then the information in the identity object will also contain details of other option modules installed in the other option slots and an appropriate EDS file containing a comprehensive parameter list will be required by the PLC. Control Techniques does not currently provide advanced EDS files, but suitable generic files are usually available from the PLC supplier. For more information on the identity object see section 6.7.23 Identity object on page 47.
Getting started
6.7.5
Requested Packet Interval (RPI) timeout trip

This timeout is defined by the EtherNet/IP protocol and is configured in the PLC master. If enabled, then SM-Ethernet will monitor the data traffic and if data is not received within the specified time, it will force a drive trip (SL1.Er, SL2.Er or SL3.Er, depending on which slot the solutions module is installed to, for Unidrive SP/Affinity/Digitax ST/ Mentor MP or SL.Er for Commander SK) and a trip code in Pr MM.50 of 50. This indicates that SM-Ethernet has detected that the cyclic data communication has been interrupted.
NOTE
The trip will only occur if the drive experiences a loss of network traffic for the specified duration, i.e. if data was being received but was then interrupted. The trip will not occur if no network traffic has been detected.
6.7.6
Read consistency (data skew)

Under normal conditions, cyclic data is sampled at the EtherNet/IP task tick rate and transmitted at the Requested Packet Interval (RPI). However, if another option module was in the process of modifying the mapped parameters while these parameters were being sampled, then the data transmitted across the network may not be consistent across the entire assembly object. If read consistency is enabled (and a trigger parameter specified) then data will only be sampled when the trigger parameter contains a non-zero value. This trigger parameter will then be set to zero after the data has been sampled. It is therefore possible, by controlling the trigger parameters, that an SM-Applications module can ensure that the values in the cyclic data parameters are not sampled until all values are updated. Whether consistency is enabled or not, data will always be consistent for an individual parameter, i.e. all 4 bytes of a 32 bit value will be consistent.
NOTE
The trigger parameter is a parameter that is used by SM-Ethernet to allow cyclic parameters to be sampled and is configured from the EtherNet/IP sub-menu of the PROTOCOLS menu. This parameter value will be set to zero when either the SM-Ethernet module or the drive is reset.
31
6.7.7
Write consistency (data skew)

Under normal conditions, cyclic data is written whenever a value in the assembly object changes. However, if another option module was in the process of reading the mapped parameters while these parameters were being written, then the data obtained will not be consistent. If write consistency is enabled (and a trigger parameter specified) then data will only be written when the trigger parameter contains a value of zero. This trigger parameter will then be set to one after the data has been written. It is therefore possible, by controlling the trigger parameters, that an SM-Applications module can ensure that the values sampled are consistent. Whether consistency is enabled or not, data will always be consistent for an individual parameter, i.e. all 4 bytes of a 32 bit value will be consistent.
NOTE
The trigger parameter is a parameter that is used by SM-Ethernet to allow cyclic parameters to be written and is configured from the EtherNet/IP sub-menu of the PROTOCOLS menu. This parameter value will be set to zero when either the SM-Ethernet module or the drive is reset. Example In this example, Pr 20.01 is set as the read trigger parameter and Pr 20.02 set as the write trigger parameter in the SM-Ethernet module, the PLC master is configured to add the values of Pr 20.11, Pr 20.12 and Pr 20.13, and write the result to Pr 20.21, the SM-Applications module is configured to increment the values of Pr 20.11, Pr 20.12 and Pr 20.13 by 1 each time the background task is executed. With read and write consistency enabled, SM-Ethernet will sample the cyclic data parameters when the value of Pr 20.01 is not zero and write the cyclic data when the value of Pr 20.02 is zero. The DPL code in the SM-Application module may be written as follows: Initial{ // Initialise variable newvalue=0 } //Initial Background{ top: if #20.02=1 then newvalue=#20.11 // Store #20.11 value #20.11=newvalue+1 // Increment #20.11 by 1 newvalue=#20.12 // Store #20.12 value #20.12=newvalue+1 // Increment #20.12 by 1 newvalue=#20.13 // Store #20.13 value #20.13=newvalue+1 // Increment #20.13 by 1 #20.01=1 // Enable sampling #20.02=0 // Enable PLC writes endif goto top: // main background loop } //Background
32
6.7.8
Non-cyclic (explicit) data transfer

Non-cyclic or explicit messaging is used to read and write parameters non-cyclically by means of assembly objects. All of the AC Drives profile attributes can be accessed using explicit messaging. For more information on the AC Drives profile see section 6.7.26 AC/DC Drive object on page 60. The Control Techniques object (class 100 or 0x64) provides access to all drive parameters using the following format. Class code: Instance: Attribute: Read code: Write code: 100 (0x64) Menu Parameter 14 (0x0E) 16 (0x10) Get_Attribute_Single Set_Attribute_Single
NOTE
An instance value of 0 is not a valid value in this context, therefore an instance value of 200 (0xC8) should be used to access menu 0 parameters. For more information on the Control Techniques object see section 6.7.27 Control Techniques object on page 64.
Getting started
6.7.9
Cyclic (implicit or polled) data transfer

Cyclic data is a method of data transfer that must be set-up during network configuration, but is transmitted automatically once configuration is complete. EtherNet/IP transfers cyclic data using assembly objects, cyclic data is also sometimes referred to as polled data or implicit data. The terms input and output refer to data from the perspective of the PLC, an output assembly object is used to transfer cyclic data from the PLC to SM-Ethernet, conversely, an input assembly object transfers data from SM-Ethernet to the PLC.
NOTE
Some PLCs provide the option of transmitting a configuration assembly object. The SMEthernet module does not use a configuration object, if one is required by the PLC configuration tool, then instance 1 should be specified with a length of 0 bytes. The web pages are used to configure the parameter information that is transmitted within the assembly objects. For more information on configuring the mapping parameters see section 6.7.10 Configuring SM-Ethernet cyclic parameters on page 33.
NOTE
Security
6.7.10 Configuring SM-Ethernet cyclic parameters

In order to use cyclic data over EtherNet/IP, SM-Ethernet must be configured to map the required parameter data to the assembly object. Object 100 (0x64) is used for reading parameters and object 101 (0x65) is used for writing parameters. To change the mapping configuration, open the web page EtherNet/IP from the PROTOCOLS menu, and select the appropriate assembly object, from here the required parameters may be mapped to the selected assembly object. Figure 6-1 on page 34, shows a sample web page configuration screen for mapping parameters. The first requirement is to set the number of bytes to be allocated (mapping size), this can range from 4 to 160 bytes in increments of 4. Each drive parameter requires 4 bytes of data, this means that the minimum number of parameters that can be allocated is 1 and the maximum is 40.
NOTE
Diagnostics Advanced features Quick reference Glossary of terms
The SM-Ethernet parameter mapping configuration screen refers to bytes of data, the PLC configuration tool may refer to words of data, a data word consists of 2 bytes or 16 bits of data. A double word (32 bits or 4 bytes) is used for each drive parameter.
Index
33
Figure 6-1 SM-Ethernet parameter mapping configuration
Parameter mapping table.
Parameter list.
A single parameter may be selected by dragging it from the parameter list on the left side of the page to the parameter mapping table on the right side of the page or, alternatively, double-clicking on it will append it to the end of the list in the table. A range of parameters may be selected by double-clicking on the Parameter mapping table at the position required to be allocated up to, the table will be automatically filled up to this position. If no parameter has been previously allocated, the first parameter in the parameter list will be used. The TIDY button can be used to remove any un-allocated spaces in the parameter mapping table by moving allocated parameters up. To remove all allocated mappings in the table, the CLEAR button can be pressed. To accept the changes made, click on the APPLY button. To cancel the changes and revert back to the previous configuration, click on the CANCEL button.
NOTE
If the web pages are not displayed as shown or do not function correctly then the browser settings may need to be checked to allow the Java script controls to function correctly.
34
6.7.11 Configuring the PLC

Due to the many different makes of PLCs available, the information in this section may not be relevant to all types of PLCs. The information supplied in this section relates to the ControlLogix family of controllers supplied by Allen Bradley.
NOTE
Although the Allen Bradley PLCs are mentioned in this document, this does not represent an endorsement of any particular PLC type or PLC manufacturer. When configuring the PLC for cyclic communication with SM-Ethernet, the length of each parameter data word and the number of parameters must be specified correctly, Figure 6-2, shows the PLC configuration for 40 input parameters and 40 output parameters, as each parameter consists of 32 bits (4 bytes), the length of each data word should be set to 32 bits (DINT - double integer word). The length of each data word (Comm Format in the PLC configuration in Figure 6-2) must normally be configured when the Ethernet module is created within the PLC and can not be changed. If a different length is required then a new Ethernet module must be created. In order to communicate with the SM-Ethernet, the PLC must have the SM-Ethernet IP address set correctly as illustrated in Figure 6-2. Figure 6-2 PLC configuration
Number of data words (parameters). Length of each data word.
SM-Ethernet IP address.
6.7.12 Assembly objects

An assembly object is an object which contains a group of attributes to control or monitor the drive operation. These attributes can be members of EtherNet/IP objects or drive parameters. SM-Ethernet supports a series of standard assembly objects (see section 6.7.13 Supported drive assembly objects on page 36) and two Control Techniques objects to access the drive parameters. Table 6.3 Control Techniques assembly objects
Number 0x64 (10010) 0x65 (10110) Type Input Output Length (bytes) 4 to 160 4 to 160 Default Length (bytes) 8 8 Default Mappings Bytes 0 to 3 Pr 10.40 Pr 6.42 Bytes 4 to 7 Pr 2.01 Pr 1.21
Advanced features Quick reference Glossary of terms Index
35
6.7.13 Supported drive assembly objects

The EtherNet/IP protocol includes a series of pre-defined assembly objects to control and monitor the drive operation. Table 6.4 Pre-defined drive assembly objects on page 36 lists these assembly objects and their functions.
NOTE
Conformance with the pre-defined assembly objects specification can only be guaranteed if the speed reference configuration of the drive has not been changed from the default settings. For information on setting default values, refer to the appropriate drive user guide. Table 6.4 Pre-defined drive assembly objects
Object 0x14 (2010) 0x15 (2110) 0x16 (2210) 0x17 (2310) 0x46 (7010) 0x47 (7110) 0x48 (7210) 0x49 (7310) Type Output Output Output Output Input Input Input Input Object name Basic speed control output. Extended speed control output. Speed and torque control output. Extended speed and torque control output. Basic speed feedback. Extended speed feedback. Basic speed and torque feedback. Extended speed and torque feedback.
6.7.14 Basic speed control

Output assembly object 0x14 (2010) The PLC or scanner must be configured for 4 output bytes (or 2 output words) if this assembly object is to be used. Table 6.5 Basic speed control
Data word Word 0 Word 1 Function Basic control word. Speed reference (SpeedRef).
Basic control word The basic control word consists of 2 bytes (16 bits), with only 2 bits of the low byte being used as shown below.
b15 b14 b13 b12 b11 b10 b9 b8
b7
b6
b5
b4
b3
b2 FaultRst
b1
b0 RunFwd
The individual bit functions are described as follows:

Name RunFwd FaultRst Control Word b0 b2 Description Set this bit to command the drive to run in the forward direction. A 0 to 1 transition will reset the drive if the drive was in a trip state.
36
NOTE
For the drive to run at the speed specified in Word 1, Pr 6.43 must be ON and bit 0, bit 7 and bit 8 of the drive control word (Pr 6.42) must all be set to 1 and the external hardware enable signal must be present. The individual bit functions for the drive control word are shown in Table 6.6 below. Table 6.6 Drive control word bit functions
Bit 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 Function Drive enable. Run forward. Jog forward. Run reverse. Forward/reverse. Run. Not stop. Auto/manual. Analog/preset reference. Jog reverse. Reserved. Reserved. Trip drive. Reserved. Keypad watchdog. Equivalent parameter Pr 6.15 Pr 6.30 Pr 6.31 Pr 6.32 Pr 6.33 Pr 6.34 Pr 6.39 N/A Pr 1.42 Pr 6.37 N/A N/A N/A Pr 10.33 N/A
Safety Mechanical Electrical Introduction information installation installation Getting started Protocols Web page FTP/custom Applications basics pages
Speed reference (SpeedRef) The speed reference word utilises 2 bytes (16 bits) as shown below.
b15 b14 b13 b12 b11 b10 b9 b8 SpeedRef (high byte) b7 b6 b5 b4 b3 b2 b1 b0
Security
SpeedRef (low byte)
For more information on the setting of the speed reference see section 6.7.26 AC/DC Drive object on page 60.
Diagnostics
6.7.15 Extended speed control

Output assembly object 0x15 (2110) The PLC or scanner must be configured for 4 output bytes (or 2 output words) if this assembly object is to be used. Table 6.7 Extended speed control
Data word Word 0 Word 1 Function Extended control word. Speed reference (SpeedRef).
37
Extended control word The extended control word consists of 2 bytes (16 bits), with only the low byte used as shown.
b15 b14 b13 b12 b11 b10 b9 b8
b7
b6 NetRef
b5 NetCtrl
b4
b3
b2 FaultRst
b1 RunRev
b0 RunFwd

Name RunFwd RunRev FaultRst NetCtrl NetRef
NOTE
Control Word b0 b1 b2 b5 b6
Description Set this bit to command the drive to run in the forward direction. Set this bit to command the drive to run in the reverse direction. A 0 to 1 transition will reset the drive if the drive was in a trip state. Used in conjunction with Pr 6.43 to enable the drive control word bits b0-b6 and bit 9 (Pr 6.42). Set this bit to command the drive to use the remote speed reference value specified in Word 1.
For the drive to run at the speed specified in Word 1, Pr 6.43 must be ON and bit 0, bit 7 and bit 8 of the drive control word (Pr 6.42) must all be set to 1 and the external hardware enable signal must be present. For information on the drive control word see Table 6.6 Drive control word bit functions on page 37. Speed reference (SpeedRef) The speed reference word utilises 2 bytes (16 bits) as shown below.
NOTE
SpeedRef (low byte)
6.7.16 Basic speed and torque control

Output assembly object 0x16 (2210) The PLC or scanner must be configured for 6 output bytes (or 3 output words) if this assembly object is to be used. Table 6.8 Basic speed and torque control
Data Word Word 0 Word 1 Word 2 Function Basic control word. Speed reference (SpeedRef). Torque reference (TorqueRef).
38
Basic control word The basic control word consists of 2 bytes (16 bits), with only 2 bits of the low byte being used as shown below.
b15 b14 b13 b12 b11 b10 b9 b8
b7
b6
b5
b4
b3
b2 FaultRst
b1
b0 RunFwd

Name RunFwd FaultRst
NOTE
Control Word b0 b2
Description Set this bit to command the drive to run in the forward direction. A 0 to 1 transition will reset the drive if the drive was in a trip state.
Getting started
For the drive to run at the speed specified in Word 1, Pr 6.43 must be ON and bit 0, bit 7 and bit 8 of the drive control word (Pr 6.42) must all be set to 1. For information on the drive control word see Table 6.6 Drive control word bit functions on page 37. Speed reference (SpeedRef) The speed reference word utilises 2 bytes (16 bits) as shown below.
Protocols
NOTE
SpeedRef (low byte)
For more information on the setting of the speed reference see section 6.7.26 AC/DC Drive object on page 60. Torque reference (TorqueRef) The torque reference word utilises 2 bytes (16 bits) as shown below.
b15 b14 b13 b12 b11 b10 b9 b8 TorqueRef (high byte) b7 b6 b5 b4 b3 b2 b1 b0
TorqueRef (low byte)
Quick reference
For more information on the setting of the torque reference see section 6.7.26 AC/DC Drive object on page 60.
39
6.7.17 Extended speed and torque control

Output assembly object 0x17 (2310) The PLC or scanner must be configured for 6 output bytes (or 3 output words) if this assembly object is to be used. Table 6.9 Extended speed and torque control
Data word Word 0 Word 1 Word 2 Function Extended control word. Speed reference (SpeedRef). Torque reference (TorqueRef).
Extended control word The extended control word consists of 2 bytes (16 bits), with only 5 bits of the low byte used as shown below.
b15 b14 b13 b12 b11 b10 b9 b8
b7
b6 NetRef
b5 NetCtrl
b4
b3
b2 FaultRst
b1 RunRev
b0 RunFwd

Name RunFwd RunRev FaultRst NetCtrl NetRef
NOTE
Control Word b0 b1 b2 b5 b6
Description Set this bit to command the drive to run in the forward direction. Set this bit to command the drive to run in the reverse direction. A 0 to 1 transition will reset the drive if the drive was in a trip state. Used in conjunction with Pr 6.43 to enable the drive control word bits b0-b6 and bit 9 (Pr 6.42). Set this bit to command the drive to use the remote speed reference value specified in Word 1.
For the drive to run at the speed specified in Word 1, Pr 6.43 must be ON and bit 0, bit 7 and bit 8 of the drive control word (Pr 6.42) must all be set to 1 and the external hardware enable signal must be present. For information on the drive control word see Table 6.6 Drive control word bit functions on page 37. Speed reference (SpeedRef) The speed reference word utilises 2 bytes (16 bits) as shown below.
NOTE
SpeedRef (low byte)
40
Torque reference (TorqueRef) The torque reference word utilises 2 bytes (16 bits) as shown below.
b15 b14 b13 b12 b11 b10 b9 b8 TorqueRef (high byte) b7 b6 b5 b4 b3 b2 b1 b0
TorqueRef (low byte)
For more information on the setting of the torque reference see section 6.7.26 AC/DC Drive object on page 60.
6.7.18 Basic speed feedback

Input assembly object 0x46 (7010) The PLC or scanner must be configured for 4 input bytes (or 2 input words) if this assembly object is to be used. Table 6.10 Basic speed feedback
Data word Word 0 Word 1
Function Basic status word. Speed feedback (SpeedActual).
Basic status word The basic status word consists of 2 bytes (16 bits), with only 2 bits of the low byte used as shown below.
b15 b14 b13 b12 b11 b10 b9 b8
b7
b6
b5
b4
b3
b2 Running1 (Fwd)
b1
b0 Faulted
Security

Bit b0 b2 Name Faulted Description Indicates whether the drive is OK or tripped (0=OK, 1=Tripped).
Diagnostics
Running1 Indicates if the drive is running in the forward direction (Fwd) (0=False, 1=True).
Advanced features
Speed feedback (SpeedActual) The speed feedback word utilises 2 bytes (16 bits) as shown below.
b15 b14 b13 b12 b11 b10 b9 b8 SpeedActual (high byte) b7 b6 b5 b4 b3 b2 b1 b0
Quick reference Glossary of terms
SpeedActual (low byte)
For more information on the speed feedback see section 6.7.26 AC/DC Drive object on page 60.
Index
41
6.7.19 Extended speed feedback

Input assembly object 0x47 (7110) The PLC or scanner must be configured for 4 input bytes (or 2 input words) if this assembly object is to be used. Table 6.11 Extended speed feedback
Data word Word 0 Word 1 Function Extended status word. Speed feedback (SpeedActual).
Extended status word The extended status word consists of 2 bytes (16 bits), with the bits having functions as shown below.
b15 b14 b13 b12 b11 b10 b9 b8 DriveState b7 At Reference b6 RefFrom Net b5 CtrlFrom Net b4 Ready b3 Running2 (Rev) b2 Running1 (Fwd) b1 Warning b0 Faulted
The DriveState byte returns a code to indicate the operating state of the drive as shown in Table 6.12 below. Table 6.12 DriveState codes
Code 1 2 3 4 5 6 7 0 b15 - b8 00000001 00000010 00000011 00000100 00000101 00000110 00000111 00000000 State Startup Not_Ready Ready Enabled Stopping Fault_Stop Faulted Vendor Specific Description This state is skipped over on CT drives. Inhibit. Ready. Run or Stop (Stop is only enabled by default in Servo mode). Deceleration or Injection. AC_UU (this will only occur if Mains Loss is enabled). Tripped. All other DriveType states, e.g. Scan, Orienting, Regen Active, etc.
The individual bits of the low byte of the extended status word are described in Table 6.13 Extended status word (low byte) on page 43.
42
Table 6.13 Extended status word (low byte)

Name Faulted Warning Running1 (Fwd) Running2 (Rev) b1 b2 b3 Bit b0 Description Indicates whether the drive is OK or tripped. 0=OK (Pr 10.01=1). 1=Tripped (Pr 10.01=0). Indicates if one of the drive alarms is active. Indicates if the drive is running in the forward direction. 0=False, 1=True. Indicates if the drive is running in the reverse direction. 0=False, 1=True. The Ready bit is set depending on which state the drive is in. Ready = True. Enabled = True. Stopping = True. All others = False. Indicates if the drive is being controlled from the Drive Control Word. 0=False, 1=True. Indicates if the speed reference is derived from Pr 1.21. 0=False (Pr 1.50<>1 OR Pr 1.49<>3). 1=True (Pr 1.50=1 AND Pr 1.49=3). Indicates if the drive speed has reached the set reference. 0=False (Pr 10.06=0). 1=True (Pr 10.06=1).
Ready
b4
Getting started
CtrlFromNet RefFromNet
b5 b6
Protocols
AtReference
b7
b15 b14 b13 b12 b11 b10 b9 b8 SpeedActuall(high byte) b7 b6 b5 b4 b3 b2 b1 b0
For more information on the speed feedback see section 6.7.26 AC/DC Drive object on page 60.
Security
6.7.20 Basic speed and torque feedback

Input assembly object 0x48 (7210) The PLC or scanner must be configured for 6 input bytes (or 3 input words) if this assembly object is to be used. Table 6.14 Basic speed and torque feedback
Data word Word 0 Word 1 Word 2 Function Basic status word Speed feedback (SpeedActual). Torque feedback (TorqueActual).
Diagnostics Advanced features Quick reference Glossary of terms Index
43
Basic status word The basic status word consists of 2 bytes (16 bits), with only the low byte used as shown below.
b15 b14 b13 b12 b11 b10 b9 b8
b7
b6
b5
b4
b3
b2 Running1 (Fwd)
b1
b0 Faulted

Bit b0 b2 Name Faulted Description Indicates whether the drive is OK or tripped (0=OK, 1=Tripped).
Running1 Indicates if the drive is running in the forward direction (Fwd) (0=False, 1=True).
b15 b14 b13 b12 b11 b10 b9 b8 SpeedActual (high byte) b7 b6 b5 b4 b3 b2 b1 b0
For more information on the speed feedback see section 6.7.26 AC/DC Drive object on page 60. Torque feedback (TorqueActual) The torque feedback word utilises 2 bytes (16 bits) as shown below.
b15 b14 b13 b12 b11 b10 b9 b8 TorqueActual (high byte) b7 b6 b5 b4 b3 b2 b1 b0
TorqueActual (low byte)
For more information on the torque feedback see section 6.7.26 AC/DC Drive object on page 60.
6.7.21 Extended speed and torque feedback

Input assembly object 0x49 (7310) The PLC or scanner must be configured for 6 input bytes (or 3 input words) if this assembly object is to be used. Table 6.15 Basic speed and torque feedback
Data word Word 0 Word 1 Word 2 Function Extended status word. Speed feedback (SpeedActual). Torque feedback (TorqueActual).
44
Extended status word The extended status word consists of 2 bytes (16 bits), with the bits having functions as shown below.
b15 b14 b13 b12 b11 b10 b9 b8 DriveState b7 At Reference b6 RefFrom Net b5 CtrlFrom Net b4 Ready b3 Running2 (Rev) b2 Running1 (Fwd) b1 Warning b0 Faulted
The DriveState byte returns a code to indicate the operating state of the drive as shown in Table 6.16. Table 6.16 DriveState codes
Code 1 2 3 4 5 6 7 0 b15 - b8 00000001 00000010 00000011 00000100 00000101 00000110 00000111 00000000 State Startup Not_Ready Ready Enabled Stopping Fault_Stop Faulted Vendor Specific Description This state is skipped over on CT drives. Inhibit. Ready. Run or Stop (Stop is only enabled by default in Servo mode). Deceleration or Injection. AC_UU (this will only occur if Mains Loss is enabled). Tripped. All other DriveType states, e.g. Scan, Orienting, Regen Active, etc.
The individual bits of the low byte of the extended status word are described in Table 6.17 Extended status word (low byte) on page 46.
45
Table 6.17 Extended status word (low byte)

Name Faulted Warning Running1 (Fwd) Running2 (Rev) Bit b0 b1 b2 b3 Description Indicates whether the drive is OK or tripped. 0=OK (Pr 10.01=1). 1=Tripped (Pr 10.01=0). Indicates if one of the drive alarms is active. Indicates if the drive is running in the forward direction. 0=False, 1=True. Indicates if the drive is running in the reverse direction. 0=False, 1=True. The Ready bit is set depending on which state the drive is in. Ready = True. Enabled = True. Stopping = True. All others = False. Indicates if the drive is being controlled from the Drive Control Word. 0=False, 1=True. Indicates if the speed reference is derived from Pr 1.21. 0=False (Pr 1.50<>1 OR Pr 1.49<>3). 1=True (Pr 1.50=1 AND Pr 1.49=3). Indicates if the drive speed has reached the set reference. 0=False (Pr 10.06=0). 1=True (Pr 10.06=1).
Ready
b4
CtrlFromNet RefFromNet
b5 b6
AtReference
b7
b15 b14 b13 b12 b11 b10 b9 b8 SpeedActuall(high byte) b7 b6 b5 b4 b3 b2 b1 b0
For more information on the speed feedback see section 6.7.26 AC/DC Drive object on page 60. Torque feedback (TorqueActual) The torque feedback word utilises 2 bytes (16 bits) as shown below.
b15 b14 b13 b12 b11 b10 b9 b8 TorqueActual (high byte) b7 b6 b5 b4 b3 b2 b1 b0
TorqueActual (low byte)
For more information on the torque feedback see section 6.7.26 AC/DC Drive object on page 60
46
6.7.22 Object Model

The Object Model has the following object classes present. Table 6.18 Supported Objects
Object Class Identity Motor Data Class Code 0x01 (110) 0x28 (4010) No. of Effect Instances 1 2 Provides device information (See Table 6.19 on page 47) Defines the motor data (For AC motors, see Table 6.25 on page 52) (For DC motors, see Table 6.27 on page 53) Provides drive control and monitoring information (See Table 6.28 on page 56) Provides information on the drive running state (See Table 6.32 on page 60) Provides an interface to drive parameters (See Table 6.34 on page 64) Provides the mechanism to configure the TCP/IP interface (See Section 6.7.28) Maintains link specific counters and status information (See Section 6.7.29)
Control Supervisor
0x29 (4110)
AC/DC Drive Control Techniques Group TCP/IP Interface
0x2A (4210) 0x64 (10010) 0xF5 (24510)
1 45 1
Ethernet Link
0xF6 (24610)
6.7.23 Identity object

Class: 0x01 (110) The identity object provides identification of and general information about the device. Table 6.19 Identity object
Attribute 1 2 3 4 6 7 Access Get Get Get Get Get Get Name VendorID DeviceType ProductCode Revision SerialNumber ProductName Data Type UINT UINT UINT USINT UDINT SHORT_STRING
Vendor ID
Name: Class Instance Attribute VendorID 0x01 0x01 0x01 Default Data Type Access 0x101 (25710) UINT Get
Quick reference
Returns the vendor ID code 0x101 (25710) for Control Techniques.
47
Device type
Name: Class Instance Attribute DeviceType 0x01 0x01 0x02 Default Data Type Access 0x02 UINT Get
Returns the device type code. The following codes are used:
Device Type code Drive type 0x02 0x13 AC Drive DC Drive
Product code
Name: Class Instance Attribute ProductCode 0x01 0x01 0x03 Default Data Type Access See below UINT Get
Returns a 16 bit value to identify the drive type, major revision number and drive mode and also links a node to the installed EDS files. If a basic EDS file is used then the product code is calculated as shown in Table 6.20 Basic product code below. Table 6.20 Basic product code
b15 b14 b13 b12 b11 b10 Product Major Revision b9 b8 b7 Mode b6 b5 b4 b3 0 b2 b1 b0
Product (b15 to b13) The product code is defined as follows:

Product Code Description AC Drive (Type: 0x02) 1 2 4 5 6 Unidrive SP Commander SK GP20 Digitax ST Affinity DC Drive (Type: 0x13) Mentor MP Reserved Reserved Reserved Reserved
Major Revision (b12 to b9) The major revision returned will be calculated from the formula: #11.29 * 3. Where #11.29 is the value of Pr 11.29 before the decimal point. e.g. For a value of 1.09 in Pr 11.29, the major revision returned is 3.
48
Mode (b8 to b6) The mode value is defined as follows:

Mode Description AC Drive (Type: 0x02) 0 1 2 3 4 Commander SE Open Loop Closed Loop Vector Servo Regen DC Drive (Type: 0x13) Reserved Reserved Mentor MP Reserved Reserved
Bits b5 to b0 are not used and will be set to 0. If an advanced EDS file is used then the product code is calculated as shown in Table 6.21 Advanced product code below. Table 6.21 Advanced product code
b15 b14 b13 b12 b11 b10 Product b9 b8 b7 Mode b6 b5 b4 Slot X b3 b2 b1 Slot Y b0 Major Revision + Slot
Product (b15 to b13) (See Table 6.20 Basic product code on page 48). Major Revision + Slot (b12 to b9) The value contains the major revision number of the drive firmware and the slot that the SM-Ethernet module is installed in. The value returned will be calculated from the formula: #11.29 * 3 + (Slot -1) Where #11.29 is the value of Pr 11.29 before the decimal point and Slot is the slot number that the SM-Ethernet module is installed in. e.g. For a value of 1.09 in Pr 11.29 and the SM-Ethernet module installed in slot 3, the value returned will be 5. Mode (b8 to b6) (See Table 6.20 Basic product code on page 48). Slot X (b5 to b3) This indicates the option module family type installed in the lowest numbered slot, excluding the slot where this SM-Ethernet is installed. Slot X = Pr MM.01/100. (Any fractional part of result ignored) Slot Y (b2 to b0) This indicates the option module family type installed in the highest numbered slot, excluding the slot where this SM-Ethernet is installed. Slot Y = Pr MM.01/100. (Any fractional part of result ignored) For the option module ID codes see Table 6.22 Option modules ID codes on page 50).
NOTE
Web page FTP/custom Applications basics pages Security Diagnostics Advanced features Quick reference Glossary of terms Index
The advanced EDS file mode is not supported on Commander SK.
49
Table 6.22 Option modules ID codes

b5 - b3 (Slot X) b2 - b0 (Slot Y) 001 001 001 001 010 010 010 010 010 010 010 011 011 011 011 011 100 100 100 100 100 100 100 100 100 101 Value 1 1 1 1 2 2 2 2 2 2 2 3 3 3 3 3 4 4 4 4 4 4 4 4 4 5 Module Family Feedback Feedback Feedback Feedback I/O I/O I/O I/O I/O I/O I/O Applications Applications Applications Applications Applications Fieldbus Fieldbus Fieldbus Fieldbus Fieldbus Fieldbus Fieldbus Fieldbus Fieldbus Position Module ID 101 102 104 104 201 203 204 205 206 207 208 301 302 303 304 305 401 403 404 406 407 408 409 410 421 501 Module SM-Resolver. SM-Universal Encoder Plus. SM-Encoder Plus. SM-Encoder Output Plus. SM-I/O Plus SM-I/O Timer SM-I/O PELV SM-I/O 24V SM-I/O 120V SM-I/O Lite SM-I/O 32 SM-Applications SM-Applications Lite SM-EZMotion SM-Applications Plus SM-Applications Lite V2 SM-LON SM-PROFIBUS DP SM-Interbus SM-CAN SM-DeviceNet SM-CANopen SM-Sercos SM-Ethernet SM-EtherCAT SM-SLM
Revision
Name: Class Instance Attribute Revision 0x01 0x01 0x04 Default Data Type Access N/A ARRAY of USINT Get
Returns 2 bytes to indicate the minor and sub-version revision numbers. If a basic generic EDS file is used then only the minor revision in the upper byte is returned as shown in Table 6.23 Basic revision on page 51.
50
Table 6.23 Basic revision

b15 b14 b13 b12 b11 b10 Minor Revision b9 b8 b7 0 b6 b5 b4 b3 b2 b1 b0 12710 (All bits set to 1)
The minor revision returned will be calculated from the formula: #11.29 Mod 100 + 1. Where #11.29 Mod 100 refers to the fractional value of Pr 11.29, (the value after the decimal point). e.g. For a value of 1.09 in Pr 11.29, the minor revision returned is 10. Bits b0 to b6 are used to inform the configuration tool that the advanced EDS file is not enabled and each bit will be set to 1. If an advanced EDS file is used then the revision number is calculated as shown below. Table 6.24 Advanced revision
b15 b14 b13 b12 b11 b10 Sub-version b9 b8 b7 0 b6 b5 b4 b3 b2 b1 b0 Minor Revision
Minor revision The minor revision returned will be calculated from the formula: #11.29 Mod 100 + 1. Where #11.29 Mod 100 refers to the fractional value of Pr 11.29, (the value after the decimal point). e.g. For a value of 1.09 in Pr 11.29, the minor revision returned is 10. Sub-version The sub-version returned will be calculated from the formula: #11.34 + 1. e.g. For a value of 1 in Pr 11.34, the sub-version returned is 2.
Serial Number
Name: Class Instance Attribute SerialNumber 0x01 0x01 0x06 Default Data Type Access N/A UDINT Get
Advanced features Quick reference Glossary of terms
Returns the least 3 significant bytes of the SM-Ethernet MAC address. The MAC address is set during production, and cannot be changed. This value is also displayed in Pr MM.35.
NOTE
This can be used to find the complete MAC address of the module by combining the numbers with 00:0D:1E:xx.xx.xx. Where xx.xx.xx. is a value in Pr MM.35 converted to base 16 (HEX). e.g. If Pr MM.35 contains the value of 1193046, this would give the complete MAC address of 00 0D 1E 12 34 56.
Index
51
Product Name
Name: Class Instance Attribute ProductName 0x01 0x01 0x07 Default Data Type Access SM-Ethernet SHORT_STRING Get
Returns 12 bytes (ASCII) to indicate the product name as a short string. The first byte specifies the number of following bytes that constitute the product name. The SMEthernet returns the string SM-Ethernet.
6.7.24 Motor data object

Class: 0x28 (4010) There are 2 instances of the Motor data object. Instance 1 will represent menu 5 motor information (motor map 1) and instance 2 will represent menu 21 motor information (motor map 2). The instance being used by the other dependant objects will be determined by Pr 21.15, to use the second motor map objects (instance 2), Pr 21.15 should be set to ON. Pr 21.15 is polled in the background task, so the user should be aware that during motor map changeover, the RPM speed reference may not be accurate. The available attributes and associated functions for the AC motor data object are shown in Table 6.25 AC Motor data object attributes below, the available attributes and associated functions for the DC motor data object are shown in Table 6.27 DC Motor data object attributes on page 53. Table 6.25 AC Motor data object attributes
AC Motor Instance Attributes Attribute ID 0x03 (310) 0x06 (610) 0x07 (710) 0x09 (910) 0x0F (1510) 0x64 (10010) Name MotorType (*) RatedCurrent RatedVoltage RatedFreq BaseSpeed Motor2Select Access Get/Set Get/Set Get/Set Get/Set Get/Set Get Set Instance 1 Pr 64.13 Pr 5.07 (scaled to 100mA units) Pr 5.09 Pr 5.06 (scaled to Hz) Pr 5.08 (scaled to rpm units) Pr 21.15 Pr 11.45 Drive Parameter Instance 2 Pr 64.14 Pr 21.07 (scaled to 100mA units) Pr 21.09 Pr 21.06 (scaled to Hz) Pr 21.08 (scaled to rpm units) Pr 21.15 Pr 11.45
(* The MotorType attribute has no effect on drive operation, it is only used to provide information to the user as shown in Table 6.26 Supported motor types below).
NOTE
In Open loop mode, only attributes 6 and 7 will be supported. Table 6.26 Supported motor types
Value 2 6 7 9 10 Motor Type AC Reserved Wound rotor induction motor Squirrel cage induction motor (default) Sinusoidal PM BL motor Trapezoidal PM BL motor DC FC DC motor Reserved Reserved Reserved Reserved
52
Table 6.27 DC Motor data object attributes

DC Motor Instance Attributes Attribute ID 0x03 (310) 0x06 (610) 0x07 (710) 0x0F (1510) 0x10 (1610) Name MotorType (*) RatedCurrent RatedVoltage BaseSpeed Access Get/Set Get/Set Get/Set Get/Set Instance 1 Pr 64.13 Pr 5.07 (scaled to 100mA units) Pr 5.09 Pr 5.08 (scaled to rpm units) Pr 5.70 (scaled to 100mA units) Pr 5.70 * Pr 5.69 / 100 Pr 5.69 = MinFieldCur * 100 / Pr 5.70 (scaled to 100mA units) Drive Parameter Instance 2 Pr 64.14 Pr 21.07 (scaled to 100mA units) Pr 21.09 Pr 21.08 (scaled to rpm units) Pr 21.24 (scaled to 100mA units) Pr 21.24 * Pr 5.69 / 100 Pr 5.69 = MinFieldCur * 100 / Pr 21.24 (scaled to 100mA units)
RatedFieldCur Get/Set
Getting started
0x11 (1710)
MinFieldCur
Get Set
Pr 5.69 will be written with Pr 5.69 will be written with the appropriate instance the appropriate instance value, depending on which value, depending on which motor map is selected. motor map is selected. Pr 5.73 Pr 21.15 Pr 11.45 Pr 21.23 Pr 21.15 Pr 11.45
Protocols
0x12 (1810) 0x64 (10010)
RatedFieldVolt Get/Set Motor2Select Get Set
(* The MotorType attribute has no effect on drive operation, it is only used to provide information to the user as shown in Table 6.26 Supported motor types on page 52).
Motor type
Name: Class Instance Attribute MotorType1 0x28 0x01 0x03 Default Data Type Access 7 USINT Get/Set
Security
Returns or sets the motor type to be used by the drive for instance 1.
Name: Class Instance Attribute MotorType2 0x28 0x02 0x03 Default Data Type Access 7 USINT Get/Set
Returns or sets the motor type to be used by the drive for instance 2.
53
Rated current
Name: Class Instance Attribute RatedCurrent1 0x28 0x01 0x06 Default Data Type Access Pr 5.07 / 10 USINT Get/Set
Returns or sets the rated motor current in Amps for instance 1. This attribute is linked to Pr 5.07. Set Get
Name: Class Instance Attribute
Pr 5.07 = RatedCurrent1 * 10. RatedCurrent1 = Pr 5.07 / 10.

RatedCurrent2 0x28 0x02 0x06 Default Data Type Access Pr 21.07 / 10 USINT Get/Set
Returns or sets the rated motor current in Amps for instance 2. This attribute is linked to Pr 21.07. Set Get Pr 21.07 = RatedCurrent2 * 10. RatedCurrent2 = Pr 21.07 / 10.
Rated voltage
Name: Class Instance Attribute RatedVoltage1 0x28 0x01 0x07 Default Data Type Access Pr 5.09 USINT Get/Set
Returns or sets the rated motor voltage in Volts for instance 1. This attribute is linked to Pr 5.09.
Name: Class Instance Attribute RatedVoltage2 0x28 0x02 0x07 Default Data Type Access Pr 21.09 USINT Get/Set
Returns or sets the rated motor voltage in Volts for instance 2. This attribute is linked to Pr 21.09.
54
Rated frequency
Name: Class Instance Attribute RatedFreq1 0x28 0x01 0x09 Default Data Type Access Pr 5.06 / 10 USINT Get/Set
Returns or sets the rated motor frequency in Hertz for instance 1. This attribute is linked to Pr 5.06. Set Get
Name: Class Instance Attribute
Pr 5.06 = RatedFreq1 * 10. RatedFreq1 = Pr 5.06 / 10.

RatedFreq2 0x28 0x02 0x09 Default Data Type Access Pr 21.06 / 10 USINT Get/Set
Returns or sets the rated motor frequency in Hertz for instance 2. This attribute is linked to Pr 21.06. Set Get Pr 21.06 =RatedFreq2 * 10. RatedFreq2 = Pr 21.06 / 10.
Base speed
Name: Class Instance Attribute BaseSpeed1 0x28 0x01 0x0F Default Data Type Access Pr 5.08 USINT Get/Set
Returns or sets the base speed of the motor in RPM for instance 1. This attribute is linked to Pr 5.08.
Name: Class Instance Attribute BaseSpeed2 0x28 0x02 0x0F Default Data Type Access Pr 21.08 USINT Get/Set
Returns or sets the base speed of the motor in RPM for instance 2. This attribute is linked to Pr 21.08.
Advanced features
Motor2Select
Name: Class Instance Attribute Motor2Select 0x28 0x01 0x64 Default Data Type Access USINT Get/Set
Selects between Motor Map 1 and Motor Map 2. This attribute is linked to Pr 11.45. When this bit is set to 1, Motor Map 2 will be active.
NOTE
Any change in this attribute will be implemented when the drive is disabled.
Index
55
6.7.25 Control Supervisor object

Class: 0x29 (4110) The Control Supervisor object provides access to various attributes which control or monitor the drive running state. The available attributes and their associated functions are shown in Table 6.28 below. Table 6.28 Control Supervisor object attributes
Attribute ID 0x03 (310) 0x04 (410) 0x05 (510) 0x06 (610) 0x07 (710) 0x08 (810) 0x09 (910) 0x0A (1010) 0x0B (1110) 0x0C (1210) 0x0D (1310) 0x0F (1510) 0x66 (10210) Name RunFwd RunRev NetCtrl State RunningFwd RunningRev Ready Faulted Warning FaultRst FaultCode CtrlFormNet DriveEnable Access Get/Set Get/Set Get/Set Get Get Get Get Get Get Get/Set Get Get Get/Set 1 0 1 0 1 0 Parameter dependence Pr 6.42 b1 Pr 6.42 b3 Pr 6.42 b7 (See Table 6.29 on page 57) Pr 10.14=0 AND Pr 10.02=1 Pr 10.14=1 OR Pr 10.02=0 Pr 10.14=1 AND Pr 10.02=1 Pr 10.14=0 OR Pr 10.02=0 (See Table 6.30 on page 58) Inverse of Pr 10.01 Pr 10.19 Dummy parameter, sets Pr 10.38 to 100 on a 0 to 1 transition (See Table 6.31 on page 59) Pr 6.42 b7=1 AND Pr 6.43=1 Pr 6.42 b7=0 OR Pr 6.43=0 Pr 6.42 b0
RunFwd
Name: Class Instance Attribute RunFwd 0x29 0x01 0x03 Default Data Type Access N/A USINT Get/Set
Set to 1 to run the drive in the forward direction. Get/Set Pr 6.42 (bit 1).
RunRev
Name: Class Instance Attribute RunRev 0x29 0x01 0x04 Default Data Type Access N/A USINT Get/Set
Set to 1 to run the drive in the reverse direction. Get/SetPr 6.42 (bit 3).
56
NetCtrl
Name: Class Instance Attribute NetCtrl 0x29 0x01 0x05 Default Data Type Access N/A USINT Get/Set
Switches between terminal and fieldbus control. Get/SetPr 6.42 (bit 7) 0 = Terminal control. 1 = Fieldbus control.
State
Name: Class Instance Attribute State 0x29 0x01 0x06 Default Data Type Access N/A USINT Get
Getting started
This returns a code to indicate the current running state of the drive as shown in Table 6.29 below. Table 6.29 Control Supervisor state attribute
Code 1 2 3 4 5 6 7 0 State Startup Not_Ready Ready Enabled Stopping Fault_Stop Faulted Vendor Specific Description This state is skipped over on CT drives Inhibit Ready Run or Stop (Stop is only enabled by default in Servo mode) Decelerating or DC injection braking ACUU (AC Under Voltage) - this will only occur if mains loss is enabled Tripped All other DriveType states, e.g. Scan, Orienting, Regen Active, etc.
Protocols Web page FTP/custom Applications basics pages Security
RunningFwd
Name: Class Instance Attribute RunningFwd 0x29 0x01 0x07 Default Data Type Access N/A USINT Get
Indicates that the drive is running in the forward direction. This attribute will be set to 1 when Pr 10.14 = 0 and Pr 10.02 = 1.
Quick reference
RunningRev
Name: Class Instance Attribute RunningRev 0x29 0x01 0x08 Default Data Type Access N/A USINT Get
Indicates that the drive is running in the reverse direction. This attribute will be set to 1 when Pr 10.14=1 and Pr 10.02=1. SM-Ethernet User Guide Issue: 6
57
Ready
Name: Class Instance Attribute Ready 0x29 0x01 0x09 Default Data Type Access N/A USINT Get
The Ready attribute will be set in accordance with the state as shown in Table 6.30 below. Table 6.30 Control Supervisor Ready attribute
Code 3 4 5 State Ready Enabled Stopping All others Ready state True True True False
Faulted
Name: Class Instance Attribute Faulted 0x29 0x01 0x0A Default Data Type Access N/A USINT Get
Indicates that the drive is tripped, i.e. not OK (inverse of Pr 10.01). Get 1 = Pr 10.01 = 0. Get 0 = Pr 10.01 = 1.
Warning
Name: Class Instance Attribute Warning 0x29 0x01 0x0B Default Data Type Access N/A USINT Get
Indicates that one of the drive alarms is active. Get Pr 10.19.
FaultRst
Name: Class Instance Attribute FaultRst 0x29 0x01 0x0C Default Data Type Access N/A USINT Get/Set
Resets the drive from a tripped condition. Sets Pr 10.38 to 100 on a 0 to 1 transition.
58
FaultCode
Name: Class Instance Attribute FaultCode 0x29 0x01 0x0D Default Data Type Access N/A USINT Get
The fault code attribute will return the ODVA fault code as follows: If the drive is not OK, the drive fault code is obtained from Pr 10.20, if the drive fault code is listed in Table 6.31, then SM-Ethernet will return the ODVA fault code as shown in Table 6.31 below. If the drive fault code is not listed in Table 6.31 then SM-Ethernet will return the ODVA code as follows: ODVA Fault Code = 0x1000 + drive fault code. Table 6.31 Control Supervisor fault code attribute
Drive Fault Code 1 2 3 4 6 ODVA Fault Code 0x3220 0x3210 0x2300 0x7112 0x9000 Drive Fault Code 20 21 26 32 ODVA Fault Code 0x2310 0x4300 0x5112 0x3130
CtrlFromNet
Name: Class Instance Attribute CtrlFromNet 0x29 0x01 0x0F Default Data Type Access N/A USINT Get
Security
Indicates whether the drive is operating under fieldbus or terminal control. This attribute will be set to 1 if Pr 6.42 (bit 7) = 1 and Pr 6.43 = 1 (fieldbus).
Diagnostics
DriveEnable
Name: Class Instance Attribute DriveEnable 0x29 0x01 0x66 Default Data Type Access N/A USINT Get/Set
Advanced features
Enables the drive. This puts the drive into the Ready state, allowing the RunFwd and RunRev attributes to control the drive. RunFwd and RunRev will have no effect if DriveEnable is not set to 1. Get/Set
NOTE
Quick reference
Pr 6.42 bit 0.
Glossary of terms
The external hardware enable signal must also be present before the drive will enter the Ready state.
Index
59
6.7.26 AC/DC Drive object

Class: 0x2A (4210) The AC/DC Drive object provides information on the drive running state and supports the following attributes: Table 6.32 AC/DC Drive object attributes
Attribute ID 0x03 (310) 0x04 (410) 0x06 (610) 0x07 (710) Name AtReference NetRef DriveMode SpeedActual Access Get Get/Set Get/Set Get Get/Set 0x08 (810) SpeedRef Get Set 0x0B (1110) 0x0C (1210) 0x1D (2910)
NOTE NOTE
Parameter dependence Pr 10.06 Pr 6.42 (bit 8) (See Table 6.33 on page 61) Closed Loop Open Loop Closed Loop Open Loop Open Loop Pr 3.02 Pr 5.04 Pr 1.21 (scaled to 0 decimal places) Pr 1.21 * 60 / NofPP (scaled to 0 decimal places) Pr 1.21 = SpeedRef * NofPP / 60 (scaled to 0 decimal places) Pr 4.20 (scaled to 1 decimal place) Pr 4.08 (scaled to 1 decimal place) 1 0 Pr 1.49=3 AND Pr 1.50=1 Pr 1.49<>3 OR Pr 1.50<>1
TorqueActual TorqueRef RefFromNet
Get Get/Set Get
NofPP = Number of Pole Pairs. NetRef can only be changed between local and remote when the drive is in speed control mode. If a change is requested when in torque mode then an error code will be returned.
AtReference
Name: Class Instance Attribute AtReference 0x2A 0x01 0x03 Default Data Type Access N/A USINT Get
Indicates that the drive is running at the requested speed. Get Pr 10.06 0 = Drive not running at requested speed. 1 = Drive running at requested speed.
NetRef
Name: Class Instance Attribute NetRef 0x2A 0x01 0x04 Default Data Type Access N/A USINT Get/Set
Selects the source of the speed reference. Get/SetPr 6.42 bit 8 0 = analog speed reference. 1 = digital speed reference.
60
NOTE
The NetRef can only be changed between local and remote when the drive is configured in speed control mode. If a change is requested when in torque mode then a Device State Conflict error code 0x10 will be returned.
DriveMode
Name: Class Instance Attribute DriveMode 0x2A 0x01 0x06 Default Data Type Access N/A USINT Get/Set
DriveMode does not allow the operating mode of the drive to be changed. Pr 4.11 will be written to as shown in Table 6.33 below, provided that the drive is already in the correct operating mode. Table 6.33 AC/DC Drive object DriveMode attribute
Access Value 1 2 2 2 3 Get 3 3 3 0 0 0 1 1 Mode (Pr 4.11) Open Loop Speed (0) Closed Loop Speed (0) Closed Loop Speed (0) Closed Loop Speed (0) Torque Control (1) Torque Control (1) Torque Control (1) Torque Control (1) Dont care User defined Torque control with speed override (2) OR Coiler/uncoiler mode (3) OR Speed control with torque feed-forward (4) Invalid Attribute Value (0x09) Open Loop Speed (0) Device State Conflict (0x10) Current drive mode (Pr 11.31) Open loop (1) Closed loop vector (2) Servo (3) Mentor MP Open loop (1) Closed loop vector (2) Servo (3) Mentor MP Regen (4) Dont care Dont care Open loop (1) Closed loop vector (2) OR Servo (3) OR Regen (4) OR Mentor MP Closed loop vector (2) OR Servo (3) OR Mentor MP Open loop (1) OR Regen (4) Open loop (1) OR Closed loop vector (2) OR Servo (3) OR Mentor MP Regen (4)
Getting started Protocols Web page FTP/custom Applications basics pages Security Diagnostics
Set
2 2
Closed Loop Speed (0) Device State Conflict (0x10)
Advanced features
3 3
Torque Control (1) Device State Conflict (0x10)
NOTE
Pr 11.31 will never be changed by setting the DriveMode attribute. An error (0x10) will be generated if the requested DriveMode value does not correspond to the current DriveType operating mode.
Index
61
SpeedActual
Name: Class Instance Attribute SpeedActual 0x2A 0x01 0x07 Default Data Type Access N/A USINT Get
Returns the actual speed of the motor in RPM. The source of the motor speed depends on the operating mode of the drive. Get Get Pr 5.04 (Open Loop). Pr 3.02 (Closed Loop or Servo).
SpeedRef
Name: Class Instance Attribute SpeedRef 0x2A 0x01 0x08 Default Data Type Access N/A USINT Get/Set
Sets or returns the speed reference in RPM. Closed loop, Servo Get/Set SpeedRef = Pr 1.21 (Scaled to 0 decimal places). Open loop Get SpeedRef = (Pr 1.21 * 60) / Pole Pairs (Scaled to 0 decimal places). Set Pr 1.21 = (SpeedRef * Pole Pairs) / 60 (Scaled to 0 decimal places).
TorqueActual
Name: Class Instance Attribute TorqueActual 0x2A 0x01 0x0B Default Data Type Access N/A USINT Get
Returns the actual load on the motor as a percentage of the rated motor load. This attribute has 1 decimal place precision, a value of 1000 represents 100.0% load. Get Pr 4.20.
TorqueRef
Name: Class Instance Attribute 0x2A 0x01 0x0C Default Data Type Access N/A USINT Get/Set
Sets the load (torque) reference as % of rated motor load (torque). This attribute has 1 decimal place precision, so a value of 1000 represents 100.0% load. Set Pr 4.08 = TorqueRef / 10. Get TorqueRef = Pr 4.08 * 10.
62
RefFromNet
Name: Class Instance Attribute RefFromNet 0x2A 0x01 0x1D Default Data Type Access USINT Get
Indicates the source of the speed reference. TRUE if Pr 1.49 = 3 and Pr 1.50 = 1. FALSE otherwise.
Getting started Protocols Web page FTP/custom Applications basics pages Security Diagnostics Advanced features Quick reference Glossary of terms Index
63
6.7.27 Control Techniques object

Class: 0x64 (10010) The Control Techniques object provides access to all drive parameters. For example, parameter Pr 4.20 would be accessed as Class 100, Instance 4, Attribute 20. Table 6.34 Control Techniques object
Instance 0x01 (110) 0x02 (210) 0x03 (310) 0x04 (410) 0x05 (510) 0x06 (610) 0x07 (710) 0x08 (810) 0x09 (910) 0x0A (1010) 0x0B (1110) 0x0C (1210) 0x0D (1310) 0x0E (1410) 0x0F (1510) 0x10 (1610) 0x11 (1710) 0x12 (1810) 0x13 (1910) 0x14 (2010) 0x15 (2110) 0x16 (2210) 0x17 (2310) 0x3C (6010) 0x3D (6110) 0x3E (6210) 0x3F (6310) 0x40 (6410) 0x46 (7010) 0x57 (8710) 0x64 (10010) 0x7F (12710) 0x82 (13010) 0x9D (15710) 0xA0 (16010) 0xBB (18710) 0xC8 (20010) Menu 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 60 61 62 63 64 70 - 87 Ramps control. Speed control. Current control. Motor control. Sequencing. Analog I/O. Digital I/O. Logic. Drive status. Drive set-up. Programmable thresholds. Position control. Process PID loop. Slot 1 configuration. Slot 2 configuration. Slot 3 configuration. User application menu 1. User application menu 2. User application menu 3. Second motor map. Additional menu 0 setup Header selections Fieldbus virtual parameter menu. General module virtual parameter menu. DNS server virtual parameter menu. Modbus TCP/IP virtual parameter menu. EtherNet/IP virtual parameter menu. Menus of option module (if installed) in the lowest numbered slot. Name Frequency / speed reference.
100 - 127 Menus of option module (if installed) in slot 1. 130 - 157 Menus of option module (if installed) in slot 2. 160 - 187 Menus of option module (if installed) in slot 3. 0 Menu 0.
64
6.7.28 TCP/IP Interface object

Class: 0xF5 (24510) The TCP/IP Interface object provides the mechanism to configure the SM-Ethernet TCP/IP network interface. Examples of configurable items include the device IP address, network mask and gateway address.
NOTE
This object is normally configured by the PLC software.
6.7.29 Ethernet Link object

Class: 0xF6 (24610) The Ethernet Link object maintains link-specific counters and status information for the Ethernet 802.3 communication interface.
NOTE
This object is normally configured by the PLC software.

65
7
7.1
Web page basics

Connecting to SM-Ethernet
If you are using DHCP, all settings on the SM-Ethernet module will be configured by the network DHCP server, you can confirm this is working by checking the IP address has been correctly configured in parameters Pr MM.10 to Pr MM.13. In order to communicate, the PC must be on the same subnet as the drive or you must have a gateway specified for the host PC and the SM-Ethernet module.
NOTE
If you are not using DHCP you will need to manually configure the address, subnet mask and default gateway (if you are connecting from a different subnet) see section 5.11 Setting the IP address on page 22.
7.1.1
Making a connection
To connect to SM-Ethernet, enter the address of the SM-Ethernet module (see section 5.11 Setting the IP address on page 22) into the browser window as follows: http://192.168.1.100 (this is the default address) Replacing the address (192.168.1.100) with the address of the SM-Ethernet module you wish to communicate with.
NOTE
The default IP address when not using DHCP is 192.168.1.100. In order to communicate with this address your PC will need to be on the same subnet or have a gateway capable of reaching this address, additionally SM-Ethernet will also require a gateway configured to communicate with the PC in this case.
66
7.2
Getting started
Protocols
Security
Diagnostics
Advanced features
Quick reference
Glossary of terms
Index
SM-Ethernet User Guide Issue: 6 Figure 7-1 Web page structure

PROTOCOLS NETWORK CONFIGURATION HELP LOG-OUT / LOG-IN
Modbus TCP/IP Email Communication EtherNet/IP User Menu Backup Reset Scheduled Events Application Parameter File Summary Modules Update Security
Web page menu structure
HOME
PARAMETERS
Home Page
Module Info
Profile
Custom Pages
The menu structure on SM-Ethernet is logically grouped by function to allow for ease of navigation.
Summary
Drive Menus
Editor
Advanced Editor
67
7.2.1
The home page

Figure 7-2 shows the initial home page when connected to SM-Ethernet. Figure 7-2 The home page
The home page contains the following main areas: Top-level menu - this is the menu that is used to navigate to the menus on SM-Ethernet. Click on the items to make a selection. Sub-menu - the sub-menu sub divides the top-level menu in to more subsections. Click on the items to make a selection. Drive details - contains more details about the SM-Ethernet usage and settings. The section also details any Solutions Modules installed to the drive and their firmware versions. User menu parameter summary - details the parameters that the user has previously defined to appear in this menu. Drive name - this is the name allocated to SM-Ethernet during set-up. Language packs installed - this area of the screen will indicate whether any languages (other than English) are installed in the module. Click on the image to select that language display or alternatively the language can be changed from within the user profile menu.
68
7.2.2
Logging in
Before you can view any additional screens you must login to SM-Ethernet. The default username is root and the default password is ut72. The root username cannot be changed, but the password should be changed to prevent unauthorized access to SMEthernet. This account is not appropriate for day to day use, and an Administrator account should be created as soon as is practically possible. The password for the root account should be noted in a secure place as this password is not reset when the module is defaulted. Figure 7-3 shows the login screen, after entering the details click the LOG-IN button to login. If you lose your passwords you will need to contact your supplier or local drive centre for instructions on how to change the password. The inactivity logout is configurable per account, although it cannot be set to Disabled for Super User and Administrator accounts.
NOTE
Passwords are case sensitive and must be at least 6 characters in length and limited to a maximum of 15 characters. For security reasons passwords should be recorded in a secure location known only to the account user. The root account password cannot be reset back to the default (ut72) as this would be less than the minimum length allowed for a password. Figure 7-3 Log-in
NOTE
Web page FTP/custom Applications basics pages Security
When you have finished working with the module you should log-out using the log out option in the top-level menu. This prevents unauthorized access to SM-Ethernet. Depending on which page is active, after a period of inactivity you may be automatically logged out. This can be configured from the Profile sub-menu of the HOME page to one of the following options: Default (10 minutes) 5 minutes 15 minutes 30 minutes 60 minutes Disabled (Read Only and General User accounts only)
Diagnostics Advanced features Quick reference Glossary of terms Index
69
7.2.3
Home
Homepage - Displays information about the drive and user configured parameters. Module Info - Shows technical information about SM-Ethernet. This information includes the MAC address, SM-Ethernet firmware version, the power-up time, file system availability and other parameters. Profile - Allows users to change passwords, languages and session timeout lengths. Custom pages - Only present if custom pages have been defined.
7.2.4
Parameters
Drive Menus - Displays a list of the menus within the host drive. Editor - Shows the parameter editor interface. The operators and source options supported by the Advanced Editor can also be used in the Update Value box to modify the selected parameter. Advanced Editor - Allows direct parameter access by means of a command line instruction, in a similar way to the immediate window in SyPTPro. The syntax of the command instruction is as follows: {#[int]mm.pp} {[operator][-][source]}
NOTE
For clarity, spaces may be inserted between command arguments as required. The terminology is described in Table 7.1 Advanced editor command line syntax . Table 7.1 Advanced editor command line syntax
Command Description Represents the destination menu and parameter. Forces parameter data type to be treated as an integer. Example Result Returns the value of Pr 20.21. Pr 1.21 displays the value 5.0. Writes the value 123 to Pr 20.21. Increments the value of Pr 20.21 value by 1. Decrements the value of Pr 20.21 value by 1. Increments the value of Pr 1.21 by the value of Pr 20.21. Decrements the value of Pr 1.21 by the value of Pr 20.21. Destination parameter (required) #mm.pp #20.21
Integer function (optional) int # int 1.21 = 50
Operator (required) = Use source value directly (optional). #20.21 = 123 Increment destination value by 1. ++ Note: Cannot be used with the - function. Decrement destination value by 1. -Note: Cannot be used with the - function. Increment destination value by source value. #20.21 -#20.21 ++
+=
#1.21 += #20.21
-=
Decrement destination value by source value.
#1.21 -= #20.21
70
Table 7.1 Advanced editor command line syntax

Command Description Example Result Exclusively ORs the value of Exclusive OR destination value with Pr 20.20 with the #20.20 ^= #20.21 source value. value of Pr 20.21 and writes the result to Pr 20.20. AND destination value with source value. ANDs the value of Pr 20.20 with the #20.20 &= #20.21 value of Pr 20.21 and writes the result to Pr 20.20. ORs the value of Pr 20.20 with the value of Pr 20.21 and writes the result to Pr 20.20.
^=
&=
|=
OR destination value with source value.
#20.20 |= #20.21
Getting started
Negate function (optional) Negates the source value Writes Pr 20.20 with a value equal, #20.20 = - #20.21 but of opposite polarity, to the Note: Cannot be used with the ++ value of Pr 20.21. or -- operators. Note: Cannot be used without the source parameter specified. Source parameter (required unless ++ or -- operators used) #mm.pp n or 0xn Represents the source menu and parameter. #20.20 = #20.21 Writes the value of Pr 20.21 into Pr 20.20
Represents a number to be used for #20.20 = 1500 Writes the value the source value. 1500 into or Pr 20.20 Note: Can be specified in decimal or #20.20 = 0x05DC hexadecimal.
Security
Parameter File - Allows a CTSoft parameter file to be downloaded from the host drive for setting up parameters.
Diagnostics
7.2.5
Protocols
Summary - Displays and allows editing of the protocol thread priority levels. Modbus TCP/IP - Displays and allows editing of the TCP/IP settings for Modbus TCP/IP. Email - Allows setting up of event triggered e-mails and configuration of the mail server settings. Scheduled Events - Configure events to trigger at certain times or on certain event conditions, also configures the time source server. EtherNet/IP - Displays and allows editing of the EtherNet/IP settings and parameter mappings.
71
7.2.6
Network
Summary - Allows SM-Ethernet to scan the local subnet for other SM-Ethernet modules. Modules - The network scan option scans for any module that is within broadcast range. This is not limited by subnets, but by gateways and proxy servers. It can be on the same subnet, or a different subnet, as long as it is not behind a gateway that does not forward broadcast messages. The web pages will only show the first 250 modules found. The modules web page can also be used to configure the IP address settings of other modules on the network, other modules do not have to have valid IP settings to be found. This means that when manually configuring IP addresses, only one module needs to be configured through parameters, the others can all be left with the default settings and configured through the web page of the module that has a valid IP address.
NOTE
The Ethernet discovery protocol is not compatible across versions. Modules running firmware version V01.00.00 may not locate modules running version V01.01.00 and above and visa-versa.
7.2.7
Configuration
Communications - Displays and allows changes to the Ethernet and TCP/IP settings. The Ethernet settings which can be changed here are baud rate, duplex mode and crossover compensation. (The only possible change in the TCP/IP section is the option to enable or disable the DHCP server). Application - Allows the displayed information on the Homepage to be viewed or changed. This includes the drive name, network name, drive function and contact details. User Menu - Allows configuration of the user menu (as shown on the home page under Parameter Summary) to be changed. Update - Allows system files, language files and backup files to be uploaded to the SM-Ethernet module. Backup - Allows data from the module to be downloaded for backup and security reasons. This file can include the application configuration, module parameter values and module security settings. This file can be uploaded to any SM-Ethernet module (Decrypt module security settings not selected) or only to the SM-Ethernet module that was used to create the backup file (Decrypt module security settings selected) using the Update menu option. Security - Provides user accounts and password management facilities along with a facility to configure the connection filters. Reset - Allows the module to be reset.
7.2.8 7.2.9
Help
These pages provide a basic level of help on the features of the SM-Ethernet module.
Log-Out
This option logs the current user out of the web pages.
72
8
8.1
FTP/custom pages Introduction

SM-Ethernet gives you the facility to generate customised web pages (similar to HMI screens) that can be viewed using a web browser. Figure 8-1 shows one of the supplied custom web pages that can be used as a starting point for your own pages. Figure 8-1 Custom web page
NOTE
To avoid potential problems Control Techniques recommend that custom web page design is performed only by suitably experienced personnel. Support on this subject will be limited to interfacing to the drive only. General web design techniques will not be supported.
Security
8.2
Managing files
In order to upload to SM-Ethernet and download from SM-Ethernet custom web pages on the drive you must connect to the drive using an FTP program. Most popular FTP programs should be suitable for this purpose.
8.3
Connections using FTP

These instructions are generic and should be suitable for most FTP programs. Open the FTP program. Set the host to the IP address of the drive you wish to communicate with. Set the port to 21. Bypass any proxy server. Set server type to ftp. Enter the user name and password for an Administrative account. See section 10.4 Account management on page 86. Select active mode. Set the default remote directory to /system/. Connect to SM-Ethernet.
73
8.4
Custom files
After connecting to SM-Ethernet you should see a listing of the file structure. Figure 8-2 Directory structure
Figure 8-2 shows an example of the directory structure on SM-Ethernet, the files required to generate custom pages are contained within the custom directory. Figure 8-3 Custom files
Figure 8-3 shows the files for the custom pages that are installed by default on SMEthernet, however index.htm is the only required file, and if this exists the custom pages will appear in the sub-menu when logged in. The files are defined as follows. smethernet.htm - contains the Javascript for connecting to the drive parameters and should not be changed. index.htm - contains examples of how to use the Javascript to display pages on a web page for monitoring of values. config.htm - contains examples of how to use Javascript to write to parameters in the drive. style.css - contains the cascading style sheet definitions for the web pages.
NOTE
images - contains the images for the custom pages, these may be added to if required.
If these files are not present then please contact your supplier or local drive centre as the custom pages will need to be uploaded into the SM-Ethernet module using the FTP connection.
74
8.5
Generating your own pages

Before starting to modify the pages on SM-Ethernet it is recommended that the current files are backed up onto your PC. This will enable you to restore the files to a known working state. The procedure for modifying the pages is as follows: Copy the directory structure to your local hard disk. Edit the index.htm and config.htm to your requirements. Add any additional web pages following the structure of index.htm and config.htm. Insert any additional images in the images directory. Upload the files to the drive and test them.
NOTE
To test the web pages on the module you will need to log-in to the web pages then select custom pages from the home page option. You can access the pages directly as http:// WWW.XXX.YYY.ZZZ/FS/system/custom/index.htm (where WWW.XXX.YYY.ZZZ is the target SM-Ethernet modules IP address). You must still be logged in to view these pages (some user accounts can be configured to be permanently logged in see section 10.6 Security levels on page 87).
Getting started
8.6
Understanding custom pages

The custom pages are controlled exclusively by the Javascript contained in the library file smethernet.htm, this contains the code required to communicate with parameters in the SM-Ethernet and the host drive. The index.htm and config.htm contain a link to smethernet.htm as a reference for the Javascripts required for displaying state, updating values and for producing some of the on-screen objects such as sliders and switches. From within index.htm and config.htm there are entries that use the features of smethernet.htm for displaying and updating values. These are contained within <script> and </script> tags as shown below: <script> new Light("light1", "10.1", {imageOn:"images/healthy_on.gif", imageOff:"images/illum_off.gif"}); </script> This process is transparent to the end user and the only browser support required is Javascript. The final stage of the process is the method that SM-Ethernet uses to communicate to the drive. The Javascript in smethernet.htm requests a URL from the drive in the format: http://129.111.0.136/US/20.21=5/dynamic/writeparval.xml This is decoded as write the value 5 to Pr 20.21 and return the result of this request in an XML web page on SM-Ethernet with address 129.111.0.136. SM-Ethernet then decodes the information in the address and returns an XML stream containing the results of the operation, as detailed below, indicating the success of the operation. <status value="0" text="OK" /> Reading of parameters is performed in a similar way but uses the URL as follows:
75
http://129.111.0.136/US/1.21/dynamic/readparval.xml This is decoded as a single read of Pr 1.21 from the SM-Ethernet module with the address 129.111.0.136. For multiple parameters each parameter is separated by the underscore character as follows: http://129.111.0.136/US/1.21_1.24/dynamic/readparval.xml The response to the URL request above would be: <parameters> <parameter name="1.21" value="55" dp="1" text="5.5Hz" /> <parameter name="1.24" value="0" dp="1" text="0.0Hz" /> </parameters> showing the values read from each parameter along with the number of decimal places for the parameter.
NOTE
To read or write the parameters you must be logged in with appropriate security access.
76
Applications
SM-Ethernet provides an alternative to the EIA-485 (RS-485) connections provided on the front of the drive. By using SM-Ethernet it is possible to communicate to the drive using the following range of Control Techniques products. CTSoft. CTScope SyPTPro. SyPTLite. OPC server.
This means that any applications that are familiar to the engineer can now be used over Ethernet as if the user were connected locally. Some parameters have a profound effect on the operation of the drive. They must not be altered without careful consideration of the impact on the controlled system. Measures must be taken to prevent unwanted changes due to error or tampering especially if a remote user can access the drive over Ethernet.
CAUTION
9.1
Minimum software versions required for Ethernet

Table 9.1 below, lists the products used in this chapter and their minimum versions of software required for Ethernet communication. Table 9.1 Required software versions for communication over Ethernet
Product Unidrive SP Commander SK Digitax ST Affinity Mentor MP SM-Applications SM-Ethernet OPC Server CTScope SyPTPro CTSoft Software Version Version 01.06.00 or later Version 01.06.00 or later Version 01.00.00 or later Version 01.00.00 or later Version 01.00.00 or later Version 01.04.05 or later Version 01.02.00 or later Version 03.01.00 or later Version 01.00.00 or later Version 02.01.00 or later Version 01.05.00 or later
Web page FTP/custom Applications basics pages Security Diagnostics Advanced features
9.2
9.2.1
CTSoft
Installing CTSoft
To install CTSoft follow the instructions provided with the software. To use CTSoft with Ethernet will require a version of CTSoft that has support for Ethernet and the associated API or communication server. Please contact the supplier of the drive for more information.
77
9.2.2
Basic configuration of CTSoft

After installing CTSoft double click on the program icon. The window shown in Figure 91 on page 78 will be displayed. Ensure the drive is connected to the Ethernet network and the PC is on the same subnet (or the drive and PC have suitable gateway addresses configured). Figure 9-1 CTSoft start-up
Select the Work with a drive option and select the correct drive type followed by clicking on the OK button. From the navigation panel (Explorer) double click on the drive properties from the list as shown in Figure 9-2 Drive properties on page 78. Figure 9-2 Drive properties
78
Figure 9-3 Drive properties settings
Advanced Settings
From the drive properties menu shown in Figure 9-3 click on the Comms Settings button and select CT-TCP/IP from the protocol drop down box, then click on advanced and change the TCP/IP Extra Timeout to 2000. Click OK and OK again to return to the screen shown in Figure 9-3. Figure 9-3 shows the settings required to specify the IP address of the SM-Ethernet module that the software will directly connect to. The IP address is always required. To connect to a single drive via Ethernet all that is required is the IP address. The Slot and Sub node fields should be left blank. To communicate through the host drive via the SM-Ethernet module to a second drive on a CTNet network, the Slot and Sub node values must be entered. The Slot is the slot number of the host drive which contains the SM-Applications module used to route the CTNet messages onto the CTNet network. The Sub node is the CTNet node address of the drive to be communicated with. For example, if the host drive has a SM-Ethernet installed in Slot 3 and a SMApplications installed in Slot 2, to communicate to a drive with a CTNet node address of 5, a slot number of 2 and a Sub node of 5 should be entered.
9.2.3
Advanced settings
These are accessed using the button (as shown in Figure 9-3). The Port number will affect all communications and should not usually be changed, any changes to this Port must be matched on the SM-Ethernet module. The Unit ID should normally be blank, if not this informs the software that a third party gateway is in use and communications via SM-Ethernet will not be possible (for a gateway example see Knowledge Base Article COMMS024).
79
Figure 9-4 Advanced TCP settings
Finally click OK to finish the configuration process. Follow the instructions provided with CTSoft to use the product. The only configuration possible using CTSoft over SM-Ethernet is a single SM-Ethernet module on a solitary network drive at the same time.
NOTE
Support for the SM-Ethernet was included in CTSoft Version 01.05.00 and above. Support for using SM-Ethernet as a gateway to CTNet was included in CTSoft Version 01.06.01 and above. For communication to be established, the serial priority parameter Pr MM.37 must be set to ON in SM-Ethernet.
NOTE
9.3
9.3.1 9.3.2
CTScope
Installing CTScope
To install CTScope, follow the instructions provided with the software.
CTScope configuration
All the appropriate configuration settings are displayed on the main screen for communication over TCP/IP with CTScope.
NOTE
For communication to be established, the serial priority parameter Pr MM.37 must be set to ON in SM-Ethernet.
9.4
9.4.1
SyPTPro
Installing SyPTPro
To install SyPTPro follow the instructions provided with the software. To use SyPTPro with Ethernet will require a version of SyPTPro that has support for Ethernet. Table 9.1 below lists the minimum software version required for communication over Ethernet for the Control Techniques products used in this section.
80
9.4.2
SyPTPro configuration
There are a number of possible configurations for using SyPTPro over Ethernet. 1. A single SM-Ethernet module on a solitary network drive. 2. A first drive hosting a single SM-Ethernet module with a single SM-Applications networked to a second CTNet enabled drive or Beckhoff bus coupler. 3. A first drive hosting two SM-Ethernet modules networked to a second CTNet drive hosting a single SM-Ethernet module. Figure 9-5 illustrates these three configurations. Figure 9-5 SyPTPro over Ethernet routing options
Option 1
Option 2
Ethernet
Option 3
Security Diagnostics Advanced features Quick reference Glossary of terms
For each configuration the following steps must be taken: 1. After installing SyPTPro double click on the program icon. The window shown in Figure 9-6, below, will be displayed. If the current protocol is not set to CT-TCP/IP
Index
81
(Ethernet), then click the Change button and a window similar to Figure 9-7, below, will be displayed, select the CT-TCP/IP protocol and click OK. 2. Select the Go online and detect drives option and click OK, the communication settings window will be displayed as shown in Figure 9-8 on page 83. 3. From the communication settings window, select the Automatically scan local network option. (SyPTPro can be instructed to search for all nodes on the local network, specific nodes grouped together on a particular network or additional networks (Ethernet or CTNet) via specified IP address(es), these addresses are added by selecting the Connect to/through specific nodes option and clicking on the Add button. Each IP address and port number (if necessary) may now be added, click on OK to accept the changes and return to the PC communication settings window). 4. When all network options are configured as required, click on OK and SyPTPro will browse the network to find all drives resident on it (depending on the configured network settings). Figure 9-6 SyPTPro startup
Figure 9-7 Drive communication settings
NOTE
For communication to be established, the serial priority parameter Pr MM.37 must be set to ON in SM-Ethernet. SM-Ethernet User Guide Issue: 6
82
Figure 9-8 PC Communication settings
5. A graphical representation of the network is displayed. Figure 9-9, below, shows the third configuration type. A first drive hosting two SM-Ethernet modules networked to a second CTNet drive hosting a single SM-Ethernet module. Figure 9-9 Hardware architecture
NOTE
For a system with multiple networks Pr MM.38 can be used to define the group in which the module is found, this is reflected in SyPTPro by the network number, for example if a module is set to group 2 it will appear on network Ethernet2 in SyPTPro. Pr MM.38 must match the network number that the module is connected to in SyPTPro otherwise the node may not be detected.
83
9.5 9.6
SyPTLite
SYPTLite is currently only supported if launched from SyPTPro.
OPC server
The Control Techniques OPC server can be used to provide communication between an OPC client (which supports the OPC data access specification) and any suitable Control Techniques drive. The OPC client configures the OPC server on which drive parameters to read and the cyclic rate at which they will be read. The OPC server will notify the client if any of the configured parameter values change, the OPC client then requests the updated value from the OPC server. The Control Techniques OPC server version 03.01.00 and above support the TCP/IP protocol used over Ethernet.
NOTE
For further information please contact the supplier of the drive.
84
10
10.1
Security
Introduction
On open networked systems it is important that security is considered. Security covers aspects such as access to devices using passwords, network infrastructure, company procedures and backup procedures. The physical system security should be enforced with acceptable user policies and appropriate employee guidelines.
10.2
General site security issues

It is important to remember that when connecting your computer to an existing network you will have an impact on the data and services on that network. Particular care should be taken not to interrupt the flow of data by disconnecting cables, powering down switches/routers, or interrupting data flow by sending large amounts of data over the network.
10.2.1 Connecting your computer
10.2.2 Virus considerations

Connecting your computer to a network carries the risk of transferring computer viruses to other computers on that network. It is vital that when connecting to a network you ensure that your anti-virus software is up to date and activated. Many operating system vendors offer regular product updates to increase stability and reduce the risk of malicious programs causing damage to your corporate infrastructure.
NOTE
Control Techniques recommend the use of a quality anti-virus solution on any networked system. The overall network security policy resides with the network administrators and any connections to a network should be approved by the network administrators.
10.2.3 Firewall issues

When a high level of security is required between the automation network and the business network a firewall should be used. This helps prevent unwanted traffic passing between the networks and can be used to restrict access to certain machines or users.
NOTE
Some managed switches provide control methods for network traffic, however a firewall offers significantly more features. Configuration of a switch or firewall is beyond the scope of this document.
Advanced features
10.3
Default restrictions
By default, access to the drive over Ethernet is set to read/write access. By default, all services are available. This can be changed using Pr MM.36 (please see section 12.4.7 SM-Ethernet disable full access on page 106 for more information).
Quick reference
10.3.1 Disable Full Access

The global write enable Pr MM.36 is set to 0 by default. This will allow parameters to be changed within the drive. To prevent changes to drive parameters over Ethernet, Pr MM.36 should be set to a 1. This will prevent changes via Modbus IP, EtherNet/IP and the web pages.
85
10.4
Account management
A user account system is provided to allow an administrator to give access rights to different classes of user. The system provides accounts for administrator and user account types. The default username root and password ut72 should be used to gain initial access to the module. Once logged on, additional accounts should be added as required, with key members of the engineering staff having supervisor access. It is recommended that a policy is put into place to ensure that passwords are recorded elsewhere. There is a limit on the number of active user accounts allowed, this limit is fixed at 10 and includes logged-in users and any communication accounts in use (e.g. FTP, EtherNet/IP, etc.). The maximum number of active logged-in user accounts is 5. A good company policy on passwords can help prevent problems occurring due to lost passwords.
NOTE
10.5
Adding new accounts

In order to add a new account you will need to follow the instructions below: 1. Log on to the web pages using the root or an administrator account. 2. Choose the top level CONFIGURATION menu then the Security menu. 3. Select Add/Modify/Remove user accounts. 4. Click on New. 5. Enter the details as requested in the menu. 6. Click Apply to finish.
NOTE
Following changes to the root account password SM-Ethernet should be reset using the reset function on the web pages.
10.5.1 Administrator accounts

Administrator accounts are intended to provide a high level of access to the drive and module settings. An administrator account should be reserved for engineering staff who have a thorough understanding of the drive, SM-Ethernet and the system. Where possible more than one person should be given administration privileges. An administrative account is required for adding/removing accounts.
10.5.2 Other user accounts

Other user accounts should be used for engineers that need to make changes to the system occasionally, different account types are available depending on the facilities and features required. For more information see section 10.6 Security levels on page 87.
86
10.6
Security levels
Security levels are provided to allow different types of users to be given different access rights to the drive and module parameters. Table 10.1 shows the access rights for specific user types. Table 10.1 Security levels
Disable session timeout View Security Setttings View Config Overviews Edit Security Settings
View Status Pages
Edit Configuration
Upload Firmware
View Parameters
View Home Page
View Help Pages
Enable Features
Edit Parameters
Getting started
Open Access Read Only General User Super User Administrator
Yes Yes Yes Yes Yes
No Yes Yes Yes Yes
No Yes Yes Yes Yes
No Yes Yes Yes Yes
No No Yes Yes Yes
No No Yes Yes Yes
No No No Yes Yes
No No No Yes Yes
No No No No Yes
No No No No Yes
No No No No Yes
N/A Yes Yes No No
Protocols
10.6.1 Limiting access

SM-Ethernet will prevent a single user logging in more than once. A maximum of 5 simultaneous web based connections are possible. It is always possible for an administrator to log in.
10.6.2 Protocol authentication

Certain protocols and services will require a user to authenticate using a password and a username. This protection is detailed in the relevant protocol section of the user guide.
10.6.3 Connection filtering

It is possible to configure SM-Ethernet to only accept connections from trusted IP, network or MAC addresses. This is a very secure method of preventing unauthorized access to the drive. A list of trusted hosts is stored in the module and only addresses on this list are able to communicate with SM-Ethernet.
NOTE
Be careful when enabling connection filtering as it is possible to lose the ability to communicate with SM-Ethernet. If this situation occurs it is possible to disable connection filtering by setting Pr MM.39 to 0.
87
11
Diagnostics
This section of the manual provides basic diagnostic information intended to enable resolution of the most common problems encountered when setting up an SM-Ethernet module on an Ethernet network. A high percentage of problems reported are basic setup problems that can be avoided by using the following pages. Start by using the Diagnostic flow chart on page 89 to determine the possible cause of a problem. If after following the flow chart you are still experiencing problems please contact your supplier or local drive supplier for support.
NOTE
Please note that support will be limited to the setting up and networking of the drive and not network infrastructure design.
11.1
LED diagnostics
The SM-Ethernet module is equipped with 4 LEDs on the front panel to aid in the diagnostics procedure. The functions of these LEDs are described in Table 11.1 LED functionality below. Table 11.1 LED functionality
LED Name Link / Activity LED State Off Steady green Flashing green Speed Off On Flashing green (slow) Flashing green (fast) Module status Steady green Flashing green and red Steady red Flash access Steady green Steady red Description Ethernet connection not detected. Ethernet connection detected. Ethernet communication detected. 10Mb/s data rate. 100Mb/s data rate. Running RAM bootloader image. Initialising main image. Running. Warning (slot or configuration error). Major fault. Reading from flash memory. Writing to flash memory.
Figure 11-1 SM-Ethernet connections and LED indicator layout

Spade connector
Link / Activity 8 7 6 5 4 3 2 1 Speed
Module status Flash access
Not used Not used Receive Not used
Transmit + Transmit Receive + Not used
88
Safety Mechanical Electrical Introduction information installation installation Protocols Security

Diagnostics
Getting started
Advanced features
Quick reference
Glossary of terms
Index
Diagnostic flow chart
11.2
89
11.3
Module identification parameters

The basic SM-Ethernet configuration parameters can be accessed through the slot menu in the drive, Pr MM.xx where MM is the menu for SM-Ethernet in the host drive.
11.3.1 SM-Ethernet module ID code

SM-Ethernet - module ID code Default Pr MM.01 Range Access 410 (SM-Ethernet) RO
The module ID code indicates the type of module installed into the slot corresponding to menu MM. This is useful for checking the module installed is of the correct type, especially when used with DPL code. The ID code for SM-Ethernet is 410.
11.3.2 SM-Ethernet firmware version

SM-Ethernet firmware - major version (xx.yy) Default Pr MM.02 Range Access Default Pr MM.51 Range Access N/A 00.00 to 99.99 RO N/A 0 to 99 RO
SM-Ethernet firmware - minor version (zz)
Unidrive SP (Sizes 1 to 6) / Unidrive SPM / Mentor MP The software version of the Solutions Modules can be identified by looking at Pr 15.02 or Pr 16.02 or Pr 17.02 and Pr 15.51 or Pr 16.51 or Pr 17.51. Menu 15,16 or 17 is Solutions Module slot dependent with menu 17 being the lowest position nearest the control terminal connections. The software version takes the form of xx.yy.zz, where Pr 15.02 or Pr 16.02 or Pr 17.02 displays xx.yy and Pr 15.51 or Pr 16.51 or Pr 17.51 displays zz (e.g. for software version 01.01.00 on a module in the middle Solutions Module slot, Pr 16.02 will display 1.01 and Pr 16.51 will display 0). Unidrive SP (Size 0) / Digitax ST / Unidrive ES / Affinity The software version of the Solutions Modules can be identified by looking at Pr 15.02 or Pr 16.02 and Pr 15.51 or Pr 16.51. Menu 15 or 16 is Solutions Module slot dependent with menu 15 (Unidrive SP size 0 and Digitax ST) or menu 16 (Unidrive ES and Affinity) being the position nearest the control terminal connections. The software version takes the form of xx.yy.zz, where Pr 15.02 or Pr 16.02 displays xx.yy and Pr 15.51 or Pr 16.51 displays zz (e.g. for software version 01.01.00 on a module in the middle Solutions Module slot (Unidrive ES and Affinity) or for Unidrive SP size 0 and Digitax ST, the Solutions Module slot nearest the incoming supply terminals), Pr 16.02 will display 1.01 and Pr 16.51 will display 0). Commander SK (Sizes B to D and 2 to 6) The software version of the Solutions Module can be identified by looking at Pr 15.02 and Pr 15.51. The software version takes the form of xx.yy.zz, where Pr 15.02 displays xx.yy and Pr 15.51 displays zz (e.g. for software version 01.01.00 Pr 15.02 will display 1.01 and Pr 15.51 will display 0).
90
11.3.3 SM-Ethernet user allocated address

SM-Ethernet - user allocated address Default Pr MM.03 Range Access 0 0 to 65535 RW
This is used as a way to identify the node on the network independently of the IP address. This is not the IP address. This allows SM-Ethernet to be identified without knowing the IP address and is used in conjunction with Pr MM.38 (see section 12.4.9 SM-Ethernet user allocated group on page 107).
11.4
Network configuration parameters

SM-Ethernet - data rate Default Pr MM.04 Range Access 0 0 to 2 RW
11.4.1 SM-Ethernet data rate
The SM-Ethernet will automatically detect the network data rate when set to 0. When using auto-detect, information about the negotiated setting will be stored in Pr MM.44. Table 11.2 SM-Ethernet baud rates
Pr MM.04 0 1 2 bit/s Auto-detect 10Mbs 100Mbs
11.4.2 SM-Ethernet DHCP enable

SM-Ethernet - DHCP enable Default Pr MM.05 Ranges Access 0 (disabled) 0 to 1 RW
Security
If set to a 0 the module will use static IP addressing and get its address, subnet mask and default gateway from parameters Pr MM.10 to Pr MM.13, Pr MM.14 to Pr MM.17 and Pr MM.18 to Pr MM.21 respectively. When set to 1 the module will obtain this information from a DHCP server on the network.
NOTE
Diagnostics
Advanced features
It is recommended that the MAC address of the SM-Ethernet module is used to allocate the IP address when DHCP is enabled.
Quick reference
11.4.3 SM-Ethernet IP address Wip

SM-Ethernet - IP address Wip Default Pr MM.10 Range Access 192 0-255 RW
This is the most significant octet of the modules IP address. When using DHCP this will be updated from the DHCP server. The IP address is in the format W.X.Y.Z.
91
If DHCP is disabled, (MM.05=0), then this parameter should be saved (xx.00=1000 or xx.00=1001 if using a DC supply to power the drive) and activated by resetting the SMEthernet module (MM.32=ON).
11.4.4 SM-Ethernet IP address Xip

SM-Ethernet - IP address Xip Default Pr MM.11 Range Access 168 0-255 RW
This is the second most significant octet of the modules IP address. When using DHCP this will be updated from the DHCP server. The IP address is in the format W.X.Y.Z. If DHCP is disabled, (MM.05=0), then this parameter should be saved (xx.00=1000 or xx.00=1001 if using a DC supply to power the drive) and activated by resetting the SMEthernet module (MM.32=ON).
11.4.5 SM-Ethernet IP address Yip

SM-Ethernet - IP address Yip Default Pr MM.12 Range Access 1 0-255 RW
This is the third most significant octet of the modules IP address. When using DHCP this will be updated from the DHCP server. The IP address is in the format W.X.Y.Z. If DHCP is disabled, (MM.05=0), then this parameter should be saved (xx.00=1000 or xx.00=1001 if using a DC supply to power the drive) and activated by resetting the SMEthernet module (MM.32=ON).
11.4.6 SM-Ethernet IP address Zip

SM-Ethernet - IP address Zip Default Pr MM.13 Range Access 100 0-255 RW
This is the least significant octet of the modules IP address. When using DHCP this will be updated from the DHCP server. The IP address is in the format W.X.Y.Z. If DHCP is disabled, (MM.05=0), then this parameter should be saved (xx.00=1000 or xx.00=1001 if using a DC supply to power the drive) and activated by resetting the SMEthernet module (MM.32=ON).
11.4.7 SM-Ethernet IP subnet mask Wsubnet

SM-Ethernet - IP subnet mask Wsubnet Default Pr MM.14 Range Access 255 0-255 RW
This is the most significant octet of the modules IP subnet mask. When using DHCP this will be updated from the DHCP server. The IP subnet mask is in the format W.X.Y.Z.
92
11.4.8 SM-Ethernet IP subnet mask Xsubnet

SM-Ethernet - IP address Xsubnet Default Pr MM.15 Range Access 255 0-255 RW
This is the second most significant octet of the modules IP subnet mask. When using DHCP this will be updated from the DHCP server. The IP subnet mask is in the format W.X.Y.Z. If DHCP is disabled, (MM.05=0), then this parameter should be saved (xx.00=1000 or xx.00=1001 if using a DC supply to power the drive) and activated by resetting the SMEthernet module (MM.32=ON).
Getting started
11.4.9 SM-Ethernet IP subnet mask Ysubnet

SM-Ethernet IP subnet mask Ysubnet Default Pr MM.16 Range Access 255 0-255 RW
This is the third most significant octet of the modules IP subnet mask. When using DHCP this will be updated from the DHCP server. The IP subnet mask is in the format W.X.Y.Z. If DHCP is disabled, (MM.05=0), then this parameter should be saved (xx.00=1000 or xx.00=1001 if using a DC supply to power the drive) and activated by resetting the SMEthernet module (MM.32=ON).
11.4.10SM-Ethernet IP subnet mask Zsubnet

SM-Ethernet - IP subnet mask Zsubnet Default Pr MM.17 Range Access 0 0-255 RW
Security
Diagnostics
This is the least significant octet of the modules IP subnet mask. When using DHCP this will be updated from the DHCP server. The IP subnet mask is in the format W.X.Y.Z. If DHCP is disabled, (MM.05=0), then this parameter should be saved (xx.00=1000 or xx.00=1001 if using a DC supply to power the drive) and activated by resetting the SMEthernet module (MM.32=ON).
Advanced features
11.4.11 SM-Ethernet IP default gateway Wgateway

SM-Ethernet IP - default gateway Wgateway Default Pr MM.18 Range Access 192 0-255 RW
This is the most significant octet of the modules IP default gateway address. When using DHCP this will be updated from the DHCP server. The default gateway address is in the format W.X.Y.Z.
93
11.4.12SM-Ethernet IP default gateway Xgateway

SM-Ethernet IP - default gateway Xgateway Default Pr MM.19 Range Access 168 0-255 RW
This is the second most significant octet of the modules IP default gateway address. When using DHCP this will be updated from the DHCP server. The default gateway address is in the format W.X.Y.Z. If DHCP is disabled, (MM.05=0), then this parameter should be saved (xx.00=1000 or xx.00=1001 if using a DC supply to power the drive) and activated by resetting the SMEthernet module (MM.32=ON).
11.4.13SM-Ethernet IP default gateway Ygateway

SM-Ethernet IP - default gateway Ygateway Default Pr MM.20 Range Access 1 0-255 RW
This is the third most significant octet of the modules IP default gateway address. When using DHCP this will be updated from the DHCP server. The IP subnet mask is in the format W.X.Y.Z. If DHCP is disabled, (MM.05=0), then this parameter should be saved (xx.00=1000 or xx.00=1001 if using a DC supply to power the drive) and activated by resetting the SMEthernet module (MM.32=ON).
11.4.14SM-Ethernet IP default gateway Zgateway

SM-Ethernet IP - default gateway Zgateway Default Pr MM.21 Range Access 254 0-255 RW
This is the least significant octet of the modules IP default gateway address. When using DHCP this will be updated from the DHCP server. The default gateway address is in the format W,X,Y,Z. If DHCP is disabled, (MM.05=0), then this parameter should be saved (xx.00=1000 or xx.00=1001 if using a DC supply to power the drive) and activated by resetting the SMEthernet module (MM.32=ON).
11.4.15SM-Ethernet Duplex mode

SM-Ethernet Duplex mode Default Pr MM.42 Range Access 0 (auto-detect) 0 to 2 RW
This parameter determines how the duplex mode is set on SM-Ethernet. When set to 0 the module will auto-negotiate the duplex mode.
94
Table 11.3 Duplex mode

Pr MM.42 0 1 2 bit/s Auto-detect. full duplex. half duplex.
If this parameter value is changed, then a module save should be performed (xx.00=1000 or xx.00=1001 if using a DC supply to power the drive) followed by resetting the SM-Ethernet module (MM.32=ON) to activate the change.
11.4.16SM-Ethernet enable auto-crossover detection

SM-Ethernet - Enable crossover detection Default Pr MM.43 Range Access 0 (disabled) 0 to 1 RW
This parameter is used to determine if the module should use auto-crossover detection or use a standard (patch) cable. If it is set to 0 you either need a cross-over cable or you need to connect via a switch. Table 11.4 Crossover detection
Pr MM.43 0 1 Crossover detection Disabled. Enabled.
If this parameter value is changed, then a module save should be performed (xx.00=1000 or xx.00=1001 if using a DC supply to power the drive) followed by resetting the SM-Ethernet module (MM.32=ON) to activate the change.
11.4.17SM-Ethernet actual baud rate

SM-Ethernet Actual baud rate Default Pr MM.44 Range Access 0 0 to 2 R
Security
Displays the baud rate at which SM-Ethernet is operating. Table 11.5 Actual baud rate
Pr MM.44 0 1 2 Actual baud rate Baud rate not set. 10Mbs. 100Mbs.
Diagnostics
Advanced features
11.4.18SM-Ethernet actual duplex mode

SM-Ethernet Actual duplex mode Default Pr MM.45 Range Access 0 0 to 2 R
Displays the duplex mode that SM-Ethernet is currently using.
Index
95
Table 11.6 Actual duplex mode

Pr MM.45 0 1 2 Actual duplex mode Duplex mode not set. Full duplex mode. Half duplex mode.
11.4.19SM-Ethernet MAC address UMAC

SM-Ethernet MAC address UMAC Default Pr 61.01 Range Access 00 (Control Techniques) 0 to 255 R
The most significant byte of the MAC address. The MAC address is a unique value specific to only a single SM-Ethernet module and takes the form U:V:W:X:Y:Z. The MAC address may be found on the product label on the outside of SM-Ethernet. This part of the MAC address will always be set to 00 as the first 3 bytes of the MAC address defines the manufacturer (Control Techniques).
11.4.20SM-Ethernet MAC address VMAC

SM-Ethernet MAC address VMAC Default Pr 61.02 Range Access 0D (Control Techniques) 0 to 255 R
The second most significant byte of the MAC address. The MAC address is a unique value specific to only a single SM-Ethernet module and takes the form U:V:W:X:Y:Z. The MAC address may be found on the product label on the outside of SM-Ethernet. This part of the MAC address will always be set to 0D as the first 3 bytes of the MAC address defines the manufacturer (Control Techniques).
11.4.21SM-Ethernet MAC address WMAC

SM-Ethernet MAC address UMAC Default Pr 61.03 Range Access 1E (Control Techniques) 0 to 255 R
The third most significant byte of the MAC address. The MAC address is a unique value specific to only a single SM-Ethernet module and takes the form U:V:W:X:Y:Z. The MAC address may be found on the product label on the outside of SM-Ethernet. This part of the MAC address will always be set to 1E as the first 3 bytes of the MAC address defines the manufacturer (Control Techniques).
96
11.4.22SM-Ethernet MAC address XMAC

SM-Ethernet MAC address XMAC Default Pr 61.04 Range Access 0 to 255 R
The fourth most significant byte of the MAC address. The MAC address is a unique value specific to only a single SM-Ethernet module and takes the form U:V:W:X:Y:Z. The MAC address may be found on the product label on the outside of SM-Ethernet. The last 3 bytes form a unique serial number for a specific SM-Ethernet.
11.4.23SM-Ethernet MAC address YMAC

SM-Ethernet MAC address YMAC Default Pr 61.05 Range Access 0 to 255 R
The fifth most significant byte of the MAC address. The MAC address is a unique value specific to only a single SM-Ethernet module and takes the form U:V:W:X:Y:Z. The MAC address may be found on the product label on the outside of SM-Ethernet. The last 3 bytes form a unique serial number for a specific SM-Ethernet.
11.4.24SM-Ethernet MAC address ZMAC

SM-Ethernet MAC address ZMAC Default Pr 61.06 Range Access 0 to 255 R
The least significant byte of the MAC address. The MAC address is a unique value specific to only a single SM-Ethernet module and takes the form U:V:W:X:Y:Z. The MAC address may be found on the product label on the outside of SM-Ethernet. The last 3 bytes form a unique serial number for a specific SM-Ethernet.
Security
11.5
Diagnostic parameters
SM-Ethernet - diagnostic information Default Pr MM.06 Range Access N/A -99 to 9999 RO
Diagnostics
11.5.1 SM-Ethernet diagnostic information
Advanced features
The diagnostic information for the SM-Ethernet can be viewed in the diagnostic information parameter (Pr MM.06). When the SM-Ethernet is communicating successfully over Ethernet, Pr MM.06 will give an indication of the number of frames that are being processed per second. For a list of operating status codes see Table 11.7 SM-Ethernet operating status codes on page 98.
97
Table 11.7 SM-Ethernet operating status codes

Pr MM.06 Status Description Running states >0 0 -1 Network ok Link established Initialisation complete Indicates the number of frames the SM-Ethernet has transmitted and received per second. A link has been established but no frames are being transmitted or received. The Solutions Module has initialised correctly but no network communication is taking place on Ethernet. Initialisation states -2 -4 -6 -8 -10 Protocols Ethernet File Drive Storage The user protocols such as the web server, discovery, modbus, etc. are being initialised. DHCP (if used) has configured the module address. The security and application settings are being loaded from the file system. Configuration files are being handled. The drive interface is being initialised. The file system and memory manager are being initialised. Boot loader states -14 -15 -16 -17 -18 -19 -20 Launch Firmware ok FLASH ok Program FLASH Download Start Functional test complete Functional test fail Drive functional test fail Thermal functional test fail RAM test fail FLASH test fail The application image was successfully extracted and about to be executed. Firmware is tested and is valid and about to be extracted to RAM. FLASH programming with new firmware finished. Downloaded firmware being written to FLASH. New firmware is being downloaded from the FTP server. Boot loader RAM image has started. Functional test states -81 -85 -86 -87 -88 -89 The functional test has completed successfully. The module cannot communicate successfully with its link partner (e.g. connected PC). The module cannot communicate successfully with the host drive. The thermal monitoring circuit on the SM-Ethernet module is not working correctly. The SDRAM memory is not working correctly. The FLASH memory is not working correctly. Error Codes -92 Major hardware fault The Solutions Module hardware is not working correctly. Remove and then re-apply power to the drive. If the problem persists the module should be replaced.
Ethernet interface The Ethernet interface is being initialised.
-93
The modules parameters have been incorrectly configured which Invalid Configurais preventing the module from continuing with its initialisation. tion Check the modules configuration. Major software fault The Solutions Module has encountered an unexpected error. Remove and then re-apply power to the drive. If the problem persists the module should be replaced. The Solutions Module has encountered an unexpected error. Remove and then re-apply power to the drive. If the problem persists the module should be replaced.
-94
-95
Initialisation Failed
98
If the SM-Ethernet module does not initialise correctly when the drive is powered up, remove the power from the module, wait for the drive under-voltage (UU) trip to disappear and re-apply the power, if the problem persists then the SM-Ethernet module should be changed.
11.5.2 SM-Ethernet non-critical warning

SM-Ethernet Solutions Module error status Default Pr MM.49 Range Access 0 0 to 255 R
This parameter provides an indication for the user that a non-critical warning condition has been encountered. Bit 0 is set if any Solutions Module warning is active. Bits 1 through 7 can be mapped to specific warnings within the module, (this is not currently possible as there are insufficient warning types to make it necessary).
Getting started
11.5.3 SM-Ethernet error status

SM-Ethernet Solutions Module error status Default Pr MM.50 Range Access 0 0 to 255 R
If an error occurs the reason for the error is written to this parameter and the drive may produce a slot error. A value of 0 indicates that the module has not detected an error. For a list of SM-Ethernet error codes see Table 11.8 SM-Ethernet error codes on page 100.
NOTE
This parameter is reset to 0 if SM-Ethernet is reset.
Security
Diagnostics
99
Table 11.8 SM-Ethernet error codes

Pr MM.50 50 51 52 53 54 55 61 62 63 65 66 70 74 75 76 80 81 82 83 84 85 86 87 90 91 96 97 98 99 Error Description EtherNet/IP Requested Packet Interval (RPI) timeout. EtherNet/IP stack has run out of memory. EtherNet/IP socket error. Maximum EtherNet/IP sessions reached. Maximum EtherNet/IP connections reached. EtherNet/IP request limit reached. Invalid configuration parameters. Error initialising drive database. Error initialising file system. Invalid read consistency parameter. Invalid write consistency parameter. No valid menu data available for the module from the drive. The Solutions Module has overheated. The drive is not responding. The Modbus connection has timed out. Inter-option communication failure. Inter-option communication to slot 1 timeout. Inter-option communication to slot 2 timeout. Inter-option communication to slot 3 timeout. Memory allocation error. File system error. Configuration file error. Language file error. Drive not supported. Drive mode not supported. EtherNet/IP error. Missed event task. The Solutions Module background task has not been completed. Software fault.
100
12
12.1
Advanced features
Email configuration
SM-Ethernet provides the facilities for sending email alerts. These emails are configured based on a trigger condition contained within a parameter.
12.1.1 Requirements
In order to send emails you will need the following:
NOTE
A mail server that accepts SMTP connections without a password. An email address for SM-Ethernet. The IP address of the mail server.
It is recommended that the address used is part of the standard corporate address structure (i.e. SMEthernet1@mycompany.com), contact your system administrator for advice on obtaining an email address. SM-Ethernet will not receive email, and facilities should be put in place to prevent mail going to this account residing on the server.
12.1.2 Setup
To setup email on SM-Ethernet you must first be logged in with appropriate permissions. From the PROTOCOLS menu select Email then select the Modify Configuration option on the menu. Enter the IP address of the mail server and the port number required (normally 25) click on APPLY to save the settings. You can now add up to 3 configurable email messages.
12.1.3 Email triggers

Under the individual email configuration screens you can configure the individual message setup for the email. The trigger requires one parameter to trigger the event and one parameter to re-arm the trigger. The parameter may be the same parameter or a different parameter depending on the application. For both trigger and re-arm you must specify the condition that must be true to generate the event. The re-arm inhibit should be used to limit the number of mails that could be sent. This is important as SM-Ethernet has the potential to generate a high volume of email, if the trigger and re-arm conditions are continuously met. Setting this parameter will prevent messages from the same source being re-sent until the inhibit time has expired. To complete the process you need to enter an appropriate email source name, a destination email address, the title of the email, any text you wish to send and then select if you wish to include a parameter file in the email. Sending a parameter file in the email is useful for determining the nature of any problems as a snapshot of the drive at the time of trigger is produced. If all settings are correct, then the email may be enabled in the Options section of the configuration page. A test email may also be generated to test the server settings.
NOTE
Security Diagnostics Advanced features Quick reference Glossary of terms
Some email servers and clients may convert the '.par' file to '.dat' if this occurs you should contact your systems administrator for assistance. If the 'From' field of an email is left blank the email will automatically be sent from the modules drive name. The drive name can be specified in the application details of the module, which is accessed from the Application menu.
NOTE
Index
101
12.2
Scheduled events
It is possible to configure the SM-Ethernet module to trigger certain events at certain times. The following examples show what can be achieved: The SM-Ethernet module could be configured to send an email once every month. Note that an event cannot send an email directly but it can change the value of a parameter. The email handler can then be configured to monitor the same parameter and to transmit when the value changes. Once every 200ms the SM-Ethernet module could trigger an Event task in an SMApplications module, causing it to sample data. A number of SM-Ethernet modules could write the current date and time to drive parameters once every second, within 50ms of each other. Thus providing each drive with a timestamp for scheduling coordinated (not synchronised) motion.
NOTE
Care must be taken to prevent a large amount of emails from being transmitted too quickly, otherwise the Ethernet network or server may be compromised. As the module has no back-up for the real-time clock it will need synchronising with an external clock every time the module is reset (except if the module has requested control of the serial communications buffer, where the reset is inhibited). In order for the clock to maintain accuracy it is important that re-synchronisation is carried out regularly. This synchronisation signal can come from a few different sources, but the module can only be configured to use a single method at any one time.
NOTE
12.2.1 Requirements
In order to schedule events based upon the time you will need a SNTP server IP address that does not require a login or a SNTP server that is broadcasting the time on the same network as the SM-Ethernet module.
12.2.2 SNTP Setup

To setup SNTP on SM-Ethernet you must first be logged in with appropriate permissions. From the PROTOCOLS menu select Scheduled Events then select the Modify Configuration option. You must now choose which type of SNTP source you wish to use. SNTP Broadcast The module can be set to receive a SNTP timestamp from a server at regular time intervals. This mechanism involves very little network traffic or configuration on the module, but does not take into account network transmission delays. SNTP Requests The module can request the time from a specified time server at regular intervals, each node would need to request the time individually when required. This mechanism is potentially more accurate than the broadcast mechanism but does require each node to be configured individually and produces more network traffic than a broadcast. If the source type is set to request you must specify the server IP address and the time interval between requests. If the SNTP source is enabled and a time duration is selected for the Update Warning Delay, then, if SM-Ethernet does not receive a time update from the specified server within the selected time, a value of 3 is written to Pr MM.49 (non-critical warning).
102
12.2.3 Events
A total of 10 events can be configured on each SM-Ethernet module. Each event has the following: Summary - Each event can be given a descriptive name and independently enabled and disabled. To delete an event, tick the "Remove" option and then "APPLY". The "Missed Event Trip" option can be used to cause a trip if more than one event is missed. Time of first event - This section is used to specify when the event will first occur. When entering Hour, Minute, Second and Millisecond data, no information of a higher resolution can be omitted. e.g. If you wish the first event to occur at 30 minutes past the next hour, then the values "--:30:00:00" must be entered (the Second and Millisecond information must be included). Event condition - This section has two options, the first option will trigger the event if the set conditions are met, the second option will trigger the event if the specified parameter contains a non-zero value. Event action - This section is used to specify what action is to be taken on the event being triggered. Recurrence rule - This section is used to specify when the event will re-occur following the start condition being met. The minimum recurrence interval is 100ms.
Getting started
Protocols
12.3
Updating and backup

The SM-Ethernet module firmware and associated files can be updated using the internal web pages from the CONFIGURATION menu then select the Update menu. Browse for the file (*.pkg) then click UPLOAD. Firmware uploads can take a few minutes and the status of the update will be shown on screen.
12.3.1 Updating SM-Ethernet firmware
NOTE
Do not reset or power down the drive when uploading firmware as this may result in data loss or corruption of the system file.
12.3.2 Updating SM-Ethernet language files

The SM-Ethernet module supports multiple languages, the language files are supplied as .pkg files (e.g. english.pkg) and can be updated (or added) using the internal web pages in the same way that the firmware is updated.
NOTE
Do not reset or power down the drive when uploading the language file as this may result in data loss or corruption of the system file.
103
12.3.3 Backup
To backup parameters in the drive using the internal web pages use the CONFIGURATION menu and select the Backup submenu. Select the options you require from the following: Application configuration data - contains information such as drive name and the information from the Current Application Configuration pages. Saved module parameter values - All the internal menus, Pr 60.xx, Pr 61.xx, Pr 62.xx and Pr MM.xx. Module specific security settings - All the usernames, passwords and security related functions. If you do not select the decrypt option below these values may only be used on the module they came from. Decrypted module security settings - Ticking this box allows the security settings above to be restored to any module. This option is only available to Adminstrative users.
Click on the SUBMIT button and choose a filename and location to save the file.
NOTE
It is recommended that before and after any changes are made a sequentially named backup is made. This means that at any point it is possible to restore the module to a previous state. In the event of data corruption or module failure the data can then be restored.
12.4
Advanced parameters
The parameters listed in this section are for advanced use only. You should only adjust the following parameters if you have a thorough understanding of SM-Ethernet and the application.
12.4.1 SM-Ethernet module management

SM-Ethernet - module management Default Pr MM.29 Range Access 0 1000 to 1999 RO
Setting this parameter to 1500 and re-initialising the module activates the protocol fail safe mode. All user protocols (modbus, FTP etc.) are disabled except for the web interface, which will start with default thread priority.
NOTE
This does not reset passwords.
12.4.2 SM-Ethernet load defaults (reset memory)

SM-Ethernet - load option defaults Default Pr MM.30 Range Access OFF OFF/ON RW
When set to ON and the SM-Ethernet module is reset (Pr MM.32 set to ON), the module will change its parameter values stored in the modules local memory to default values. Any user changes or user web pages in the module will be lost. During this operation communications will be stopped. This parameter will automatically revert to OFF following the operation. Pr MM.32 must be set to ON to activate the change (see section 5.17 Re-initialising SM-Ethernet on page 26).
104
NOTE
The use of this parameter will lose any configuration in the module. Unless you have made a backup copy of the modules configuration you will lose all settings. All passwords and users are deleted, the root password remains unchanged.
12.4.3 SM-Ethernet save option parameters (backup)

SM-Ethernet - save option parameters Default Pr MM.31 Range Access OFF OFF/ON RW
This will save the modules current configuration in its local memory. During this operation communications will be stopped. This will save menu 60 (Pr MM.xx), menu 61, web page customisations, email settings, etc. This parameter should only be used to transfer a SM-Ethernet module to a different drive or when you wish to save any internal parameters directly (i.e. Pr 61.10). In order to save these parameters in the drives memory a drive save must be performed. This is required as SM-Ethernet will take its operating parameters directly from the slot memory on the host drive at startup.
NOTE
To save the parameters in the drive, a value of 1000 should be entered in Pr xx.00 followed by a drive reset (press the reset button, or toggle the reset input, or write the value 100 to Pr 10.38). * If the drive is in the under-voltage trip state or is fed from a low voltage backup supply, the value 1001 should be used and not 1000.
12.4.4 SM-Ethernet re-initialise

SM-Ethernet re-initialise Default Pr MM.32 Range Access OFF OFF/ON RW
This will force the module to re-initialise and start up with the values contained in the slot menu of the host drive (MM.xx). This parameter will automatically reset to OFF after completion. During this operation communications will be stopped.
NOTE
Security
The transition of MM.32 from OFF to ON may not be visible on the drive display due to the update rate of the display. Writing 1070 to menu Pr MM.00 (to re-initialise all option modules) may not re-initialise the SM-Ethernet module. The handling of 1070 within SM-Ethernet is dependent on the state of Pr MM.37. See section 12.4.8 SM-Ethernet reduce serial interface priority on page 107 for further information.
NOTE
105
12.4.5 SM-Ethernet restore parameters

SM-Ethernet - restore parameters Default Pr MM.33 Range Access OFF OFF/ON RW
This will change the operating parameters for the module by copying the configuration from the backup copy in the SM-Ethernet module. During this operation communications will be stopped. The restored parameters will include menu 60 (Pr MM.xx), menu 61, web page customisations, email settings, etc. This will not save the current operating menu of the drive (Pr MM.xx), a drive save must be performed to achieve this.
12.4.6 SM-Ethernet serial number

SM-Ethernet - serial number Default Pr MM.35 Range Access N/A 0 to 9999 R
The serial number is programmed into the module at the time of manufacture and consists of the least significant 3 bytes of the MAC address in decimal format.
NOTE
This can be used to find the complete MAC address of the module by combining the numbers with 00:0D:1E:xx.xx.xx. Where xx.xx.xx. is a value in Pr MM.35 converted to base 16 (HEX). e.g. If Pr MM.35 contains the value of 1193046, this would give the complete MAC address of 00 0D 1E 12 34 56.
12.4.7 SM-Ethernet disable full access

SM-Ethernet - disable full access Default Pr MM.36 Range Access OFF (enabled) OFF/ON RW
This parameter will restrict a remote users access to the drive. Pr MM.36 = ON ensures that write access to the drive is disabled. Pr MM.36 = OFF allows full access to the drive parameters. With this parameter enabled access to the following is not allowed. Modbus TCP/IP write. EtherNet/IP write. FTP upload. Web page write access to SM-Ethernet.
106
12.4.8 SM-Ethernet reduce serial interface priority

SM-Ethernet reduce serial interface priority Default Pr MM.37 Range Access
NOTE
OFF OFF/ON RW
It is not possible for the drive and SM-Ethernet module to support all of the available serial communication protocols simultaneously. This parameter, when set, allows SMEthernet to request the highest priority (not relevant for Commander SK). When on: The SM-Ethernet module will request highest priority (its actual state is shown in Pr 6.50) and the following restrictions will be applied: The drives serial interface will only be able to handle messages of 32 bytes or less. This will restrict the use of the software tools CTSoft, CTScope, OPC server, SyPTPro and SyPTLite when communicating via the RJ45 serial interface connector. An LCD keypad mounted directly to the drive will not work. A remote LCD keypad will work when connected to the RJ45 serial communications port. A Solutions Module reset using Pr MM.00 = 1070 may not work.
When off: Access to drive parameters and SM-Application parameters will still be allowed. This will restrict the use of the software tools CTSoft, CTScope, OPC server, SyPTPro and SyPTLite over Ethernet as SM-Ethernet will not be able to route messages using inter-option communications.
NOTE
When routing through SM-Ethernet to CTNet, this parameter must be set to ON. Failure to set this parameter ON will result in communication loss or unstable communications. For a system with multiple modules installed, the priority should be set for the module that is receiving the incoming request. Only one option module can have priority of the serial communications buffer at any time, priority access will be given to the first module requesting it.
Security
NOTE
Diagnostics
NOTE
12.4.9 SM-Ethernet user allocated group

SM-Ethernet - User allocated group Default Pr MM.38 Range Access 0 0 to 65535 RW
This parameter can be used to provide logical groups for Control Techniques drives. This will allow grouping independently of the IP settings. This is used in conjunction with parameter Pr MM.03 (see section 12.4.10 SM-Ethernet user allocated address on page 108).
107
12.4.10SM-Ethernet user allocated address

SM-Ethernet - user allocated address Default Pr MM.03 Range Access 0 0 to 65535 RW
This is used as a way to identify the node on the network independently of the IP address.
12.4.11SM-Ethernet connection filtering

SM-Ethernet - Connection filtering Default Pr MM.39 Range Access 0 (disabled) 0 or 1 RW
When set to a 1 the connection filter list will be enabled. If you make a mistake configuring the connection filtering and cannot connect to the module, setting this parameter to 0 will allow communication to be restored.
12.5
Modbus TCP/IP (CT implementation)

Modbus TCP/IP is one of the most widely supported Industrial Ethernet based protocols offering the functionality and simplicity of the Modbus protocol, combined with the flexibility of Ethernet. The SM-Ethernet implementation of Modbus TCP/IP uses a subset of the standard protocol provided by the Modbus organisation. Modbus TCP/IP is an application layer protocol for communication between automation devices utilising an Ethernet network connection. It is a client-server protocol where the client sends a request and waits for the server to respond.
NOTE
The default port for Modbus TCP/IP communication is 502, but this may be reconfigured using Pr 63.01 on SM-Ethernet.
12.5.1 Data structure

Communication between devices is based upon Application Data Units (ADUs) as shown in Figure 12-1. The ADU consists of two parts, the Modbus Application Protocol (MBAP) (Table 12.1) and the Protocol Data Units (see Table 12.2). Modbus TCP/IP extends the standard PDU to include an IP specific 7-byte header called the Modbus Application Protocol (MBAP). Figure 12-1 ADU
MBAP
PDU ADU (TCP/IP)
NOTE
It is important that when you implement the Modbus TCP ADU as shown in Figure 12-1, you include the MBAP as well as the PDU. The rest of this section does not repeat the MBAP header for each function code for reasons of clarity.
NOTE
108
12.5.2 Data access

Data access using Modbus TCP/IP takes the form of a request for data by the master, followed by a response from the slave indicating either success (response), or failure (exception response) as shown in Figure 12-2. If no response is received this indicates that the message has not been received or the node is unable to reply. Figure 12-2 Modbus TCP/IP- request, response, exception
Function Code
Response Data
PDU (Response) Function Code Function Data
PDU (Request) Function Code Exception Data
Getting started
PDU (Exception Response)

MBAP and PDU message structure The following tables document the structure of the MBAP and PDU, specifically the functions of each data byte within the overall message structure. Table 12.1 MBAP
Byte 0 1 2 3 4 5 6 Description Transaction identifier MSB. Transaction identifier LSB. Protocol identifier MSB. Protocol identifier LSB. Length MSB. Length LSB. Unit identifier.
Table 12.2 PDU

Consists of Function code, 1 byte Request Function data, > 1 byte Function code, 1 byte Response Response data, > 1 byte Exception Error code, 1 byte Response Exception code, 1 byte
NOTE
Security
PDU
If accessing one of the SM-Applications parameters (menus 7x, 8x or 9x) on a drive with more than one SM-Applications module installed, the message will be routed to the SM-Applications module installed in the lowest slot number, if this is undesireable then the direct access parameters (menus 10x, 11x, 12x, etc) should be used.
109
12.6
Supported Modbus function codes

Table 12.3 below, details the supported Modbus function codes on SM-Ethernet. All function codes write to 16 bit registers only, to write to a 32 bit destination see section 12.6.1 Extended data types on page 110. Table 12.3 Supported function codes
Code Decimal Hex. 3 0x03 6 0x06 16 0x10 23 0x17 Description Read multiple 16 bit registers. Write single 16 bit register. Write multiple 16 bit registers. Read and write multiple 16 bit registers.
NOTE
Control Techniques register numbers are referenced from 0 to 65535 rather than the traditional 1 to 65536. This is because the Control Techniques implementation of Modbus in the receiving node adds 1 to the register number effectively preventing access to parameter Pr 00.00 within the drive.
12.6.1 Extended data types

Standard Modbus registers are 16 bits in size and reference a single drive parameter (Pr xx.xx). To support 32 bit data types (both integer and floating point) the Modbus multiple read and write services are used to transfer a contiguous array of 16 bit registers. Control Techniques products typically contain a mix of 16 bit and 32 bit registers. To permit the client to select the appropriate 16 bit or 32 bit access the top two bits of the register address are used to select the required data type as shown in Figure 12-3. Figure 12-3 Modbus register data type selection
bit 15 bit 14 bit 13 - 0
Type select
Parameter address
The extended data types are defined such that the type 00 allows for backwards compatibility. Table 12.4 Data type field
Type field bits 15-14 00 01 10 11 Selected data type INT16 INT32 Float 32** Reserved Comments Backward compatible. None. IEEE794 standard not supported on all servers. None.
**Not currently supported.

NOTE
Control Techniques drive parameters currently do not support Float32. To overcome this INT32 should be used to represent 32 bit values. If a 32 bit data type is selected then the server uses two consecutive 16 bit Modbus registers in 'big endian' format (MSB transmitted first). For details of the data types within each product please consult the documentation for that product or contact your supplier.
110
12.6.2 FC03-Read multiple registers

This function code allows a contiguous array of registers to be read. The server (drive) imposes an upper limit on the number of registers that may be read and If this is exceeded the server will issue an exception code 2. Table 12.5 Client request message
Byte 0 1 2 3 4 5 Description Server destination node address, 0 is broadcast. Function code 0x03. Start register address MSB. Start register address LSB. Number of 16 bit registers MSB. Number of 16 bit registers LSB.
Table 12.6 Server (drive) response message

Byte 0 1 2 3 4 5 6 Description Server source node address. Function code 0x03. Length of register data (bytes). Register data 0 MSB. Register data 0 LSB. Register data 1 MSB. Register data 1 LSB.
Getting started
NOTE NOTE
For each byte in the PDU message, the MSB is transmitted first, followed by the LSB. If only one 16 bit register of a 32 bit register address is read the server returns the least significant word. For multiple registers, the register data will be returned in ascending order, beginning with the start register address. The Modbus CRC bytes are not required when using TCP/IP due to the ethernet frame providing the error checking. Writes a value to a single 16 bit register. The normal response is an echo of the request after the register contents have been successfully written. The register address can correspond to a 32 bit parameter but only the least significant 16 bits of data will be returned. Table 12.7 Client request message
Byte 0 1 2 3 4 5 Description Server destination node address, 0 is broadcast. Function code 0x06. Register address MSB. Register address LSB. Register data MSB. Register data LSB.
NOTE
NOTE
12.6.3 FC06-Write single register
Security

Byte 0 1 2 3 4 5 Description Server source node address. Function code 0x06. Register address MSB. Register address LSB. Register data MSB. Register data LSB.
Diagnostics Advanced features Quick reference
NOTE
To write 32 bits of data to a 32 bit register address, the extended data type must be used (see section 12.6.1 Extended data types on page 110). For each byte in the PDU message, the MSB is transmitted first, followed by the LSB. The Modbus CRC bytes are not required when using TCP/IP due to the ethernet frame providing the error checking.
Glossary of terms
NOTE NOTE
Index
111
12.6.4 FC16-Write multiple registers

Writes a contiguous array of registers. The server imposes an upper limit on the number of registers that can be written. If this is exceeded the server will discard the request and the client will time out. Table 12.9 Client request message
Byte 0 1 2 3 4 5 6 7 8 9 10
NOTE NOTE

Byte 0 1 2 3 4 5 Description Server source node address. Function code 0x10. Start register address MSB. Start register address LSB. Number of 16 bit registers written MSB. Number of 16 bit registers written LSB.
Description Server destination node address, 0 is broadcast. Function code 0x10. Start register address MSB. Start register address LSB. Number of 16 bit registers MSB. Number of 16 bit registers LSB. Length of register data to write (bytes). Register data 0 MSB. Register data 0 LSB. Register data 1 MSB. Register data 1 LSB.
For each byte in the PDU message, the MSB is transmitted first, followed by the LSB. For multiple registers, the register data is transmitted in ascending order, beginning with the start register address. The Modbus CRC bytes are not required when using TCP/IP due to the ethernet frame providing the error checking.
NOTE
112
12.6.5 FC23-Read and write multiple registers

Reads and writes two contiguous arrays of registers. The server imposes an upper limit on the number of registers that can be written. If this is exceeded the server will discard the request and the client will time out. Table 12.11 Client request message
Byte 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14
NOTE NOTE

Byte 0 1 2 3 4 5 6 Description Server source node address. Function code 0x17. Length of register data in read (bytes). Register data 0 MSB. Register data 0 LSB. Register data 1 MSB. Register data 1 LSB.
Description Server destination node address, 0 is broadcast. Function code 0x17. Start register address to read MSB. Start register address to read LSB. Number of 16 bit registers to read MSB. Number of 16 bit registers to read LSB. Start register address to write MSB. Start register address to write LSB. Number of 16 bit registers to write MSB. Number of 16 bit registers to write LSB. Length of register data to write (bytes). Register data 0 MSB. Register data 0 LSB. Register data 1 MSB. Register data 1 LSB.
For each byte in the PDU message, the MSB is transmitted first, followed by the LSB. For both the request and response message, the register data is transmitted in ascending order, beginning with the start register address. The Modbus CRC bytes are not required when using TCP/IP due to the ethernet frame providing the error checking.
NOTE
113
12.7
Modbus exception codes

Modbus exceptions are a response that indicates a failed operation by the client. This is signalled by the addition of 0x80 in the function code of the response. The specific error can be identified by the next byte which contains the error code ID, corresponding to the table below. Table 12.13 Exception error codes
ID Code 0x01 0x02 0x04 Description The received function code is not FUNCTION_NOT_SUPPORTED supported on the server, i.e. not FC3, FC6, FC16 or FC23. The parameter reference and/or the TOO_MANY_REGISTERS transfer length are/is invalid. This error is generated when a response SERVER_FAILURE to a routed message is found to be corrupt. CRC error occurred. This can occur if the module is trying to SERVER_BUSY route a message but it cannot get control of the drives communications buffer. This occurs if there is no response to a GATEWAY_PROBLEM_NO_RESPONSE routed message. Name
0x06 0x0B
114
13
13.1
Quick reference
Complete parameter reference
The table below lists all the SM-Ethernet set-up parameters that are required to configure the module. Table 13.1 SM-Ethernet parameter reference
Parameter Pr MM.01 Pr MM.02 Pr MM.03 Pr MM.04 Pr MM.05 Pr MM.06 Pr MM.10 Pr MM.11 Pr MM.12 Pr MM.13 Pr MM.14 Pr MM.15 Pr MM.16 Pr MM.17 Pr MM.18 Pr MM.19 Pr MM.20 Pr MM.21 Pr MM.29 Pr MM.30 Pr MM.31 Pr MM.32 Pr MM.33 Pr MM.35 Pr MM.36 Pr MM.37 Default 410 0 0 0 0 192 168 1 100 255 255 255 0 192 168 1 254 0 OFF OFF OFF OFF 0 OFF OFF Section 5.11 on page 22 Cross reference Description Section 11.3.1 on Module ID code. page 90 Section 11.3.2 on Option software version. page 90 Section 11.3.3 on User allocated address. page 91 Section 11.4.1 on Ethernet data rate. page 91 Section 11.4.2 on DHCP enable. page 91 Section 11.5.1 on Ethernet module diagnostic information. page 97 IP address Wip. IP address Xip. IP address Yip. IP address Zip. Subnet mask Wsubnet. Section 5.12 on Subnet mask Xsubnet. page 23 Subnet mask Ysubnet. Subnet mask Zsubnet Default gateway Wgateway. Section 5.13 on Default gateway Xgateway. page 24 Default gateway Ygateway. Default gateway Zgateway. Section 12.4.1 on Module management. page 104 Section 12.4.2 on Load option defaults. page 104 Section 12.4.3 on Save option parameters. page 105 Section 12.4.4 on Request to re-initialise. page 105 Section 12.4.5 on Restore parameters. page 106 Section 12.4.6 on Serial number (partial MAC address). page 106 Section 12.4.7 on Disable full access. page 106 Section 12.4.8 on Reduce SP serial interface priority. page 107
115
Table 13.1 SM-Ethernet parameter reference

Parameter Pr MM.38 Pr MM.39 Pr MM.42 Pr MM.43 Pr MM.44 Pr MM.45 Pr MM.49 Pr MM.50 Pr MM.51 Default 0 0 0 0 0 0 Cross reference Description Section 12.4.9 on User allocated group. page 107 Section 12.4.11 on page 108 Section 11.4.15 on page 94 Section 11.4.16 on page 95 Section 11.4.17 on page 95 Section 11.4.18 on page 95 Connection filtering. Duplex mode. Crossover detection. Actual baud rate. Actual duplex mode.
Section 11.5.2 on Non-critical warning condition. page 99 Section 11.5.3 on Solutions Module error status. page 99 Section 11.3.2 on Solutions Module software sub-version. page 90
Table 13.2 SM-Ethernet virtual parameter reference

Parameter Pr 60.00 Pr 60.01 Pr 60.02 Pr 60.03 Pr 60.04 Pr 60.05 Pr 60.06 Pr 60.10 Pr 60.11 Pr 60.12 Pr 60.13 Pr 60.14 Pr 60.15 Pr 60.16 Pr 60.17 Pr 60.18 Pr 60.19 Pr 60.20 Pr 60.21 Pr 60.29 Pr 60.30 Pr 60.31 Pr 60.32 Pr 60.33 Pr 60.35 Default 0 410 0 0 0 0 192 168 1 100 255 255 255 0 192 168 1 254 0 OFF OFF OFF OFF 0 Description Menu 60 Parameter zero. Module ID code. Option software version. User allocated address. Ethernet data rate. DHCP enable. Ethernet module diagnostic information. IP address Wip. IP address Xip. IP address Yip. IP address Zip. Subnet mask Wsubnet. Subnet mask Xsubnet. Subnet mask Ysubnet. Subnet mask Zsubnet. Default gateway Wgateway. Default gateway Xgateway. Default gateway Ygateway. Default gateway Zgateway. Module management. Load option defaults. Save option parameters. Request to re-initialise. Restore parameters. Serial number (partial MAC address).
116

Parameter Pr 60.36 Pr 60.37 Pr 60.38 Pr 60.39 Pr 60.42 Pr 60.43 Pr 60.44 Pr 60.45 Pr 60.49 Pr 60.50 Pr 60.51 Pr 61.00 Pr 61.01 Pr 61.02 Pr 61.03 Pr 61.04 Pr 61.05 Pr 61.06 Pr 61.07 Pr 61.10 Pr 61.11 Pr 61.12 Pr 61.13 Pr 61.14 Pr 61.15 Pr 61.20 Pr 61.21 Pr 61.30 Pr 61.31 Pr 61.32 Pr 61.33 Pr 61.34 Pr 61.50 Pr 61.51 Pr 62.00 Pr 62.01 Pr 62.02 Pr 62.03 Pr 62.04 Pr 62.05 Pr 62.06 Pr 62.07 Default OFF OFF 0 0 0 0 0 0 0 4 (High) Description Disable full access. Reduce SP serial interface priority. User allocated group. Connection filtering. Duplex mode. Crossover detection. Actual baud rate. Actual duplex mode. Non-critical warning condition. Solutions Module error status. Solutions Module software sub-version. Menu 61 Parameter zero. MAC address UMAC. MAC address VMAC. MAC address WMAC. MAC address XMAC. MAC address YMAC. MAC address ZMAC. Slot indicator. Modbus thread priority.
3 (Medium) FTP thread priority. 3 (Medium) SMTP thread priority. 3 (Medium) HTTP thread priority. 4 (High) 4 (High) 5000 2000 2000 30000 30000 250 500 0 0 0 0 0 0 0 0 Event thread priority. EtherNet/IP thread priority. Modbus thread tick time (s). EtherNet/IP thread tick time (s). Discovery and identification process silent period (ms). Discovery and identification process maximum search time (ms). Discovery and identification process search retention time (ms). IP communications timeout (ms). IP routing timeout (ms). Bootloader software version. Bootloader software sub-version. Menu 62 Parameter zero. Primary DNS server WDNS1. Primary DNS server XDNS1. Primary DNS server YDNS1. Primary DNS server ZDNS1. Secondary DNS server WDNS2. Secondary DNS server XDNS2. Secondary DNS server YDNS2.
117

Parameter Pr 62.08 Pr 62.09 Pr 62.10 Pr 62.11 Pr 62.12 Pr 63.00 Pr 63.01 Pr 63.02 Pr 63.03 Pr 63.04 Pr 63.05 Pr 63.06 Pr 63.10 Pr 63.11 Pr 63.12 Pr 63.13 Pr 63.14 Pr 63.15 Pr 63.16 Pr 63.17 Pr 63.18 Pr 63.19 Pr 63.20 Pr 63.21 Pr 63.22 Pr 63.23 Pr 63.24 Pr 63.25 Pr 63.26 Pr 63.27 Pr 63.28 Pr 63.29 Pr 64.00 Pr 64.01 Pr 64.02 Pr 64.03 Pr 64.04 Pr 64.05 Pr 64.06 Default 0 0 0 0 0 0 502 10 5 2 OFF 1000 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 ON OFF 0 OFF 0 Description Secondary DNS server ZDNS2. Tertiary DNS server WDNS3. Tertiary DNS server XDNS3. Tertiary DNS server YDNS3. Tertiary DNS server ZDNS3. Menu 63 Parameter zero. Listening Modbus TCP/IP port. Maximum number of concurrent Modbus connections. Maximum number of priority Modbus connections. Maximum number of priority connections per client. Modbus timeout enable. Modbus timeout time (ms). 1st Priority connection. 2nd Priority connection. 3rd Priority connection. 4th Priority connection. 5th Priority connection. 6th Priority connection. 7th Priority connection. 8th Priority connection. 9th Priority connection. 10th Priority connection. 11th Priority connection. 12th Priority connection. 13th Priority connection. 14th Priority connection. 15th Priority connection. 16th Priority connection. 17th Priority connection. 18th Priority connection. 19th Priority connection. 20th Priority connection. Menu 64 Parameter zero. Parameter alignment. Endianism. Read consistency. Read consistency trigger parameter. Write consistency. Write consistency trigger parameter.
118

Parameter Pr 64.10 Pr 64.11 Pr 64.12 Pr 64.13 Pr 64.14 Pr 64.15 Pr 64.16 Pr 64.20 Pr 64.21 Pr 64.22 Pr 64.23 Pr 64.24 Pr 64.25 Pr 64.26 Pr 64.27 Pr 64.28 Pr 64.29 Pr 64.30 Pr 64.31 Pr 64.32 Pr 64.33 Pr 64.34 Pr 64.35 Pr 64.36 Pr 64.37 Pr 64.38 Pr 64.39 Pr 64.40 Pr 64.41 Pr 64.42 Pr 64.43 Pr 64.44 Pr 64.45 Pr 64.46 Pr 64.47 Pr 64.48 Pr 64.49 Pr 64.50 Pr 64.51 Pr 64.52 Pr 64.53 Pr 64.54 Pr 64.55 Pr 64.56 Pr 64.57 Default ON OFF 7 7 8 8 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 Description Connection status RPI timeout trip enable. Advanced EDS file enable. Motor 1 type. Motor 2 type. Primary input assembly object size (bytes). Primary output assembly object size (bytes). Input mapping parameter 1. Input mapping parameter 2. Input mapping parameter 3. Input mapping parameter 4. Input mapping parameter 5. Input mapping parameter 6. Input mapping parameter 7. Input mapping parameter 8. Input mapping parameter 9. Input mapping parameter 10. Input mapping parameter 11. Input mapping parameter 12. Input mapping parameter 13. Input mapping parameter 14. Input mapping parameter 15. Input mapping parameter 16. Input mapping parameter 17. Input mapping parameter 18. Input mapping parameter 19. Input mapping parameter 20. Input mapping parameter 21. Input mapping parameter 22. Input mapping parameter 23. Input mapping parameter 24. Input mapping parameter 25. Input mapping parameter 26. Input mapping parameter 27. Input mapping parameter 28. Input mapping parameter 29. Input mapping parameter 30. Input mapping parameter 31. Input mapping parameter 32. Input mapping parameter 33. Input mapping parameter 34. Input mapping parameter 35. Input mapping parameter 36. Input mapping parameter 37. Input mapping parameter 38.
Safety Mechanical Electrical Introduction information installation installation Getting started Protocols Web page FTP/custom Applications basics pages Security Diagnostics Advanced features Quick reference Glossary of terms Index
119

Parameter Pr 64.58 Pr 64.59 Pr 64.60 Pr 64.61 Pr 64.62 Pr 64.63 Pr 64.64 Pr 64.65 Pr 64.66 Pr 64.67 Pr 64.68 Pr 64.69 Pr 64.70 Pr 64.71 Pr 64.72 Pr 64.73 Pr 64.74 Pr 64.75 Pr 64.76 Pr 64.77 Pr 64.78 Pr 64.79 Pr 64.80 Pr 64.81 Pr 64.82 Pr 64.83 Pr 64.84 Pr 64.85 Pr 64.86 Pr 64.87 Pr 64.88 Pr 64.89 Pr 64.90 Pr 64.91 Pr 64.92 Pr 64.93 Pr 64.94 Pr 64.95 Pr 64.96 Pr 64.97 Pr 64.98 Pr 64.99 Default 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 Description Input mapping parameter 39. Input mapping parameter 40. Output mapping parameter 1. Output mapping parameter 2. Output mapping parameter 3. Output mapping parameter 4. Output mapping parameter 5. Output mapping parameter 6. Output mapping parameter 7. Output mapping parameter 8. Output mapping parameter 9. Output mapping parameter 10. Output mapping parameter 11. Output mapping parameter 12. Output mapping parameter 13. Output mapping parameter 14. Output mapping parameter 15. Output mapping parameter 16. Output mapping parameter 17. Output mapping parameter 18. Output mapping parameter 19. Output mapping parameter 20. Output mapping parameter 21. Output mapping parameter 22. Output mapping parameter 23. Output mapping parameter 24. Output mapping parameter 25. Output mapping parameter 26. Output mapping parameter 27. Output mapping parameter 28. Output mapping parameter 29. Output mapping parameter 30. Output mapping parameter 31. Output mapping parameter 32. Output mapping parameter 33. Output mapping parameter 34. Output mapping parameter 35. Output mapping parameter 36. Output mapping parameter 37. Output mapping parameter 38. Output mapping parameter 39. Output mapping parameter 40.
NOTE
The parameters in Table 13.2 are configured internally by the web pages and should not be altered via parameter access directly.
120
14
Glossary of terms
Address: This is the unique network identification given to a networked device to allow communication on a network. When a device sends or receives data the address is used to determine the source and the destination of the message. Assembly object: A software component within the SM-Ethernet which allows access to the parameters within the drive or which allows control and monitoring of the drive by using the EtherNet/IP protocol. Attribute: A sub-division of a Class which uniquely identifies a specific command. e.g. The VendorID is an attribute of the Identity object class. Used in conjunction with the Class and Instance properties. Auto-crossover detection: A method used to automatically detect if a crossover or non-crossover network cable is connected. ADU: Application Data Unit. The complete Modbus message frame (ADU) consists of the Modbus Application Protocol (MBAP) and Protocol Data Unit (PDU). Bit: A binary digit, this may have the value of 1 or 0. Byte: A collection of 8 binary digits that collectively store a value. This may be signed or unsigned. Class: A collection of properties which allow the control or monitoring of a device. Used in conjunction with the Instance and Attribute properties. Consistency: A method of ensuring that the data transferred over the network is transmitted as a single entity, thus preventing data skew when multiple bytes are transmitted. Control word: A collection of binary digits that are used to control the drive. Features typically include directional controls, run controls and other similar functions. Crossover lead: A network cable where the terminal connections at one end of the cable are connected straight through to the other end with the exception of the data pair which are transposed. Normally used to connect two network devices together as a separate network. Cyclic (implicit or polled) data: Data that is transmitted at regular intervals over the network. Sometimes referred to as Implicit data or Polled data. Data rate: Determines the communication speed of the network, the higher the value the more data can be sent across the network in the same time period. Device: A piece of equipment connected to a network, this may be any type of equipment including repeaters, hubs, masters or slaves.
121
DNS: Domain Name Server. This is a server that is used to convert a URL such as www.controltechniques.com to an IP address such as 129.254.254.106. Double word: A 32 bit word, this may be signed or unsigned. DHCP: Dynamic Host Configuration Protocol. This is a method of allocating IP settings of a node from a central server. Grounding: Describes the electrical safety or shielding connections for the module. EDS File: Electronic Data Sheet file. A file which specifies the EtherNet/IP device functionality. Ethernet address: See MAC address. EtherNet/IP: An industrial application layer protocol for communicating to devices over Ethernet. The EtherNet/IP protocol communicates to the drive using assembly objects. Exception codes: An error response from Modbus. Explicit data: See Non-cyclic data. Firewall: A computer or piece of software that restricts connections between different ports. This can be useful when restricting data flow between two network segments. FTP: File Transfer Protocol. Used for transferring files. Gateway: A device that allows devices on different subnets or networks to communicate with each other. Hub: A method of connecting computers together on Ethernet. An un-switched hub will repeat any data received on one port to all ports. HTTP: Hypertext transfer protocol. This is a document specification protocol. Commonly used in web pages. Implicit data: See Cyclic data. Instance: A collection of properties (Attributes) that are contained within a Class. Used in conjunction with the Class and Attribute properties. IP: Internet Protocol, this is the protocol used to transmit bytes across an IP network. IP address: An address that identifies a node uniquely on a subnet or network. IP subnet: A part of an IP network that consists of a range of addresses that may be accessed by all devices on the same network directly. LED: Light Emmiting Diode. Long word: A 32 bit data word that may be signed or unsigned.
122
LSB: Least Significant Bit/Byte. MAC address: This is a unique address that is assigned to SM-Ethernet at the time of manufacture. No other device will have this address. The address is used to make connections to the module before the IP address is assigned. MBAP: Modbus application protocol. This is a 7 byte header added to the main Modbus telegram (PDU) which contains IP specific identifiers. Modbus IP: A protocol that allows Modbus to be sent over TCP/IP. The modbus protocol allows manipulation of the parameters within the host drive and SM-Ethernet. MSB: Most Significant Bit/Byte. Node: A device on the network. This may be either a device such as a drive or part of the network such as a repeater. Non-crossover lead: See Patch lead.
Safety Mechanical Electrical Introduction information installation installation Getting started Protocols
Non-cyclic (explicit) data: Data that is requested or sent as required and not on a regular basis. Sometimes referred to as Explicit data. Octet: A collection of 8 binary digits which form a byte. Patch lead: A network cable where the terminal connections at one end of the cable are connected straight through to the other end on a pin to pin basis. Normally used to connect a network device to a network switch. PC: Personal Computer. PDU: Protocol Data Unit. This is the main Modbus message telegram, to which is added the MBAP header to form the complete Modbus telegram. PLC: Programming Logic Controller. Poll rate: The rate at which cyclic data is sent and received on the network. Polled data: See Cyclic data. RPI: Requested Packet Interval. Specifies the expected time for the device to respond to a request. Router: A device that is used to connect different networks or subnets, in a similar way to a firewall, however a router generally allows significantly less control of the data. Scan rate: See Poll rate. Shielding: A connection to provide additional immunity to noise used on a network cable. SMTP: Simple Mail Transfer Protocol. A protocol used for sending email.
Web page FTP/custom Applications basics pages Security Diagnostics Advanced features Quick reference Glossary of terms Index
123
SNTP: Simple Network Time Protocol. A protocol used for synchronising time over a network. Status word: A value that denotes the status of the drive. Each bit within the word will have a specific meaning. Subnet: A part of a network that has IP addresses in the same range. Devices on the same subnet may communicate directly with other devices on the same subnet without the use of a gateway. Subnet mask: Defines which part of the IP address constitutes the subnet address and which part constitutes the host device address. Switch: A device that allows Ethernet devices to be interconnected. TCP: Transmission Control Protocol, this protocol is responsible for ensuring that the data on the network reaches its destination. URL: Uniform Resource Locator. A method used to give a web site a friendly name such as www.controltechniques.com as an alternative to an IP address. VPN: Virtual Private Network. A method of using a non-secure or public network that allows devices to be connected together as if they were a part of a private network. Word: A collection of 16 binary digits. XML: Extensible Markup Language. A document definition that is intended to transfer data.
124
Index
A
AC/DC Drive object ....................................................................................60 Account management ................................................................................86 Actual baud rate .........................................................................................95 Actual duplex mode ....................................................................................95 Adding new accounts .................................................................................86 Addressing .................................................................................................17 Addressing etiquette ...................................................................................18 Administration accounts .............................................................................86 Advanced EDS File ....................................................................................31 Advanced parameter editor ........................................................................70 Alternative notation .....................................................................................19 Applications ................................................................................................77 Assembly object .................................................................................35, 121 Attribute ....................................................................................................121
B
Backup .....................................................................................................105 Basic speed and torque control ..................................................................38 Basic speed and torque feedback ..............................................................43 Basic speed control ....................................................................................36 Basic speed feedback ................................................................................41 Baud rate ....................................................................................................25
C
Cable shield connections ...........................................................................13 Cabling .......................................................................................................13 Cabling considerations ...............................................................................13 Cautions .......................................................................................................5 Class A addresses .....................................................................................19 Class B addresses .....................................................................................19 Class C addresses .....................................................................................19 Class D & E addresses ..............................................................................19 Class Types ................................................................................................18 Client request ...........................................................................111, 112, 113 Complete parameter reference ................................................................115 Completing the address .............................................................................20 Compliance ..................................................................................................6 Configuration ..............................................................................................72 Configuring SM-Ethernet cyclic parameters ...............................................33 Configuring the PLC ...................................................................................35 Conformance ................................................................................................9 Connecting .................................................................................................66 Connecting a PC ........................................................................................15 Connection and indications ........................................................................12 Connection filtering .............................................................................87, 108 Connection of network subnets ..................................................................16 Connections using FTP ..............................................................................73 Control Supervisor object ...........................................................................56 SM-Ethernet User Guide Issue: 6
125
Control Techniques assembly objects ........................................................35 Control Techniques object ..........................................................................64 Crossover correction ..................................................................................95 CTNet .........................................................................................................79 CTSoft ........................................................................................................77 Custom files ................................................................................................74 Custom web pages .....................................................................................29 Cyclic (implicit or polled) data ...................................................................121 Cyclic (implicit or polled) data transfer .......................................................33
D
Data format .................................................................................................91 Data rate ...............................................................................................25, 91 Default gateway ....................................................................................24, 93 Default password ........................................................................................69 Default restrictions ......................................................................................85 Default username .......................................................................................69 DHCP considerations .................................................................................20 DHCP enable .......................................................................................25, 91 DHCP options .............................................................................................25 DHCP server configuration .........................................................................26 Diagnostic flow chart ..................................................................................89 Diagnostic parameters ...............................................................................97 Diagnostics .................................................................................................88 Disable full access ....................................................................................106 Downloading .............................................................................................103 Drive save ..................................................................................................27 Duplex mode ..............................................................................................94
E
EDS File ...................................................................................................122 Electrical installation ...................................................................................12 Electrical safety ............................................................................................5 Email ..........................................................................................................29 Email configuration ...................................................................................101 Email triggers ...........................................................................................101 EN954-1 .......................................................................................................5 Environmental limits .....................................................................................6 Error codes ...............................................................................................100 Error status .................................................................................................99 Ethernet Link object ....................................................................................65 EtherNet/IP .........................................................................................30, 122 Extended data types .................................................................................110 Extended speed and torque control ...........................................................40 Extended speed and torque feedback ........................................................44 Extended speed control ..............................................................................37 Extended speed feedback ..........................................................................42
F
File system .................................................................................................29 Firewall issues ............................................................................................85 Firewalls .....................................................................................................14 Firmware updates .......................................................................................30
126
Firmware version ........................................................................................90 Fixed IP addressing ....................................................................................20 FTP .............................................................................................................29 FTP/custom pages .....................................................................................73
G
General safety considerations for remote operation ....................................7 Generating your own pages .......................................................................75 Getting started ............................................................................................17 Glossary of terms .....................................................................................121 Grounding ...................................................................................................13
H
Help ............................................................................................................72 Home page ...........................................................................................68, 70 HTTP ..........................................................................................................29 Hubs ...........................................................................................................14
Getting started
I
ID code .......................................................................................................90 Installing CTSoft .........................................................................................77 Installing SyPTPro ......................................................................................80 Instance ....................................................................................................122 Introduction ...................................................................................................8 IP address ......................................................................................19, 22, 91
J
JAVA scripts ...............................................................................................75
L
Language packs .........................................................................................68 Languages ............................................................................................29, 30 Layout .........................................................................................................12 LED Diagnostics .........................................................................................88 Length of cable ...........................................................................................13 Load defaults ............................................................................................104 Logging in ...................................................................................................69 Low voltage supply .....................................................................................27
M
MAC address ..............................................................................................96 Managing files ............................................................................................73 Menu 20 .....................................................................................................27 Minimum software versions required for Ethernet ................................17, 77 Modbus exception codes ..........................................................................114 Modbus function codes ......................................................................28, 110 Modbus TCP/IP ..........................................................................................28 Modbus TCP/IP configuration ....................................................................28 Module identification ...................................................................................90 Module information .....................................................................................12 Module management ................................................................................104 Motor ............................................................................................................6
N
Network ......................................................................................................72 SM-Ethernet User Guide Issue: 6
127
Network configuration parameters .............................................................91 Network connections ..................................................................................15 Network design ...........................................................................................17 Network length ...........................................................................................13 Network topology ........................................................................................14 Node to node cable length .........................................................................14 Non-cyclic (explicit) data ..........................................................................123 Non-cyclic (explicit) data transfer ...............................................................33
O
Object Class .............................................................................................121 Object Model ..............................................................................................47 OPC server .........................................................................................84, 107 Operating status ...................................................................................26, 97 Operating status codes ..............................................................................98 Option modules ID codes ...........................................................................50
P
Parameter editor .........................................................................................70 Parameter File ............................................................................................71 Parameter reference ................................................................................115 Parameters .................................................................................................70 Parameters - adjusting .................................................................................6 Passwords ............................................................................................69, 82 PC/PLC considerations ..............................................................................28 Problems ....................................................................................................88 Protocols ..............................................................................................28, 71
Q
Quick reference ........................................................................................115
R
Read consistency .......................................................................................31 Re-arm .....................................................................................................101 Reduce SP serial interface priority ...........................................................107 Registers ....................................................................................................28 Re-initialising SM-Ethernet .................................................................26, 105 Requested Packet Interval (RPI) Timeout Trip ...........................................31 Reset memory ..........................................................................................104 Restore parameters ..................................................................................106 RJ45 Terminals ..........................................................................................12 Routers .......................................................................................................14 Routing .......................................................................................................20
S
Safety information ........................................................................................5 Safety of personnel ......................................................................................5 Save option parameters ...........................................................................105 Saving parameters .....................................................................................27 Scheduled events .....................................................................................102 SECURE DISABLE ......................................................................................5 Security ......................................................................................................85 Security levels ............................................................................................87 Serial number ...........................................................................................106
128
Server response .......................................................................111, 112, 113 Set-Up Flow Chart ......................................................................................21 Shield .........................................................................................................13 Site security ................................................................................................85 SM-Applications .........................................................................................27 SM-LON module - front view ......................................................................11 SMTP .........................................................................................................29 SNTP ............................................................................................29, 30, 102 Sub menu ...................................................................................................68 Subnet mask ........................................................................................19, 23 Supported drive assembly objects .............................................................36 Switch - using a single switch .....................................................................16 Switch - using multiple switches .................................................................16 Switches .....................................................................................................14 SyPTLite ...............................................................................................82, 83
T
TCP/IP Interface object ..............................................................................65 Top level menu ...........................................................................................68
Protocols
U
Understanding custom pages .....................................................................75 Unlock code ................................................................................................69 Un-switched hubs .......................................................................................14 Updating SM-Ethernet firmware ...............................................................103 Updating SM-Ethernet language files .......................................................103 Uploading .................................................................................................103 User accounts ............................................................................................86 User allocated address .......................................................................91, 108 User allocated group ................................................................................107 UU trip ........................................................................................................27
V
Virtual parameter reference ......................................................................116 Virtual Private Network (VPN) ....................................................................15 Virus considerations ...................................................................................85
W
Warnings ......................................................................................................5 Web page ...................................................................................................29 Web page basics ........................................................................................66 Web page menu structure ..........................................................................67 Where do IP addresses come from? ..........................................................17 Write consistency .......................................................................................32
X
XML ............................................................................................................75
129
0471-0047-06

CT - SM-Ethernet User Guide

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

CT - SM-Ethernet User Guide

Uploaded by

Copyright:

Available Formats

User Guide

Part Number: 0471-0047-06 Issue: 6

Safety information .................................................................... 5

Mechanical installation .......................................................... 11

Electrical installation ............................................................. 12

Getting started ........................................................................ 17

SM-Ethernet User Guide Issue: 6

Web page basics .................................................................... 66

FTP/custom pages ................................................................. 73

Advanced features ............................................................... 101

Quick reference .................................................................... 115

Glossary of terms ................................................................. 121

SM-Ethernet User Guide Issue: 6

Safety Mechanical Introduction information installation

Electrical safety - general warning

Protocols Web page FTP/custom Applications basics pages

System design and safety of personnel

Security Diagnostics Advanced features Quick reference Glossary of terms Index

SM-Ethernet User Guide Issue: 6

Compliance with regulations

SM-Ethernet User Guide Issue: 6

General safety considerations for remote operation

SM-Ethernet User Guide Issue: 6

SM-Ethernet User Guide Issue: 6

Solutions Module identification

Safety Mechanical Electrical Introduction information installation installation Getting started

Protocols Web page FTP/custom Applications basics pages

Customer and date code Serial number

Date code format

Security Diagnostics Advanced features

Quick reference Glossary of terms Index

SM-Ethernet User Guide Issue: 6

Conventions used in this guide

Table 2.1 Drive menu availability

SM-Ethernet User Guide Issue: 6

Safety Mechanical Electrical Introduction information installation installation

SM-Ethernet User Guide Issue: 6

Link / Activity 8 7 6 5 4 3 2 1 Speed (On = 100Mbs)

Module status Flash access

Not used Not used Receive Not used

Transmit + Transmit Receive + Not used

Table 4.1 RJ45 pin out details

SM-Ethernet User Guide Issue: 6

Safety Mechanical Electrical Introduction information installation installation

SM-Ethernet cable shield connections

Getting started Protocols

Web page FTP/custom Applications basics pages

Maximum network length

Security Diagnostics Advanced features Quick reference

Glossary of terms Index

SM-Ethernet User Guide Issue: 6

Minimum node to node cable length

Control Techniques do not recommend the use of un-switched hubs.

SM-Ethernet User Guide Issue: 6

Safety Mechanical Electrical Introduction information installation installation

Typical network connections

cross over cable

Advanced features Quick reference Glossary of terms

SM-Ethernet User Guide Issue: 6

Single PC to multiple SM-Ethernet using a single switch

Non-crossover cable Switch Non-crossover cable

Single PC to multiple SM-Ethernet using more than one switch

Non-crossover cables Switch

Non-crossover cable or crossover cable (check device documentation)