SM-Ethernet User Guide Issue 7 (0471-0047-07)
SM-Ethernet User Guide Issue 7 (0471-0047-07)
SM-Ethernet User Guide Issue 7 (0471-0047-07)
SM-Ethernet
Solutions Module for:
• Unidrive SP
• Commander SK
• Digitax ST
• Mentor MP
• Affinity
Documentation
Manuals are available to download from the following locations: http://www.drive-setup.com/ctdownloads
The information contained in this manual is believed to be correct at the time of printing and does not form part of
any contract. The manufacturer reserves the right to change the specification of the product and its performance,
and the contents of the manual, without notice.
Environmental policy
Control Techniques Ltd operates an Environmental Management System (EMS) that conforms to the
International Standard ISO 14001.
When electronic products reach the end of their useful life, they must not be disposed of along
with domestic waste but should be recycled by a specialist recycler of electronic equipment.
Control Techniques products are designed to be easily dismantled into their major component
parts for efficient recycling. The majority of materials used in the product are suitable for
recycling.
Product packaging is of good quality and can be re-used. Large products are packed in wooden
crates. Smaller products are packaged in strong cardboard cartons which have a high recycled
fibre content. Cartons can be re-used and recycled. Polythene, used in protective film and bags
for wrapping the product, can be recycled. When preparing to recycle or dispose of any product
or packaging, please observe local legislation and best practice.
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.
Further information on our compliance with REACH can be found at: http://www.drive-setup.com/reach
Registered Office
Nidec Control Techniques Ltd
The Gro
Newtown
Powys
SY16 3BE
UK
Registered in England and Wales. Company Reg. No. 01236886.
Copyright
The contents of this publication are believed to be correct at the time of printing. In the interests of a 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 contents 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.
Safety
1.1 Warnings, cautions and notes
Introduction
A Warning contains information, which is essential for avoiding a safety hazard.
Mechanical
installation
WARNING
installation
Electrical
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.
Protocols
designers and installers
This guide applies to products which control electric motors either directly (drives) or
basics
In all cases the hazards associated with powerful electrical drives are present, and all
safety information relating to drives and associated equipment must be observed.
Specific warnings are given at the relevant places in this guide.
pages
Drives and controllers are intended as components for professional incorporation into
complete systems. If installed incorrectly they may present a safety hazard. The drive
Applications
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, commissioning/
Security
start-up and maintenance must be carried out by personnel who have the necessary
training and competence. They must read this safety information and this guide
carefully.
Diagnostics
1.3 Responsibility
It is the responsibility of the installer to ensure that the equipment is installed correctly
with regard to all instructions given in this guide. They must give due consideration to
Advanced
features
the safety of the complete system, so as to avoid the risk of injury both in normal
operation and in the event of a fault or of reasonably foreseeable misuse.
The manufacturer accepts no liability for any consequences resulting from
reference
This guide contains instructions for achieving compliance with specific EMC standards.
information
Safety
Instructions in this guide regarding transport, storage, installation and use of the
equipment must be complied with, including the specified environmental limits. This
includes temperature, humidity, contamination, shock and vibration. Drives must not be
Introduction
subjected to excessive physical force.
Mechanical
The equipment must not be installed in a hazardous environment (i.e. a potentially
installation
explosive environment).
1.11 Motor
installation
Electrical
The safety of the motor under variable speed conditions must be ensured.
To avoid the risk of physical injury, do not exceed the maximum specified speed of the
motor.
Getting
started
Low speeds may cause the motor to overheat because the cooling fan becomes less
effective, causing a fire hazard. The motor should be installed with a protection
thermistor. If necessary, an electric forced vent fan should be used.
Protocols
The values of the motor parameters set in the drive affect the protection of the motor.
The default values in the drive must not be relied upon. It is essential that the correct
value is entered in the Motor Rated Current parameter.
pages
standards of quality and robustness, they are not intended for use as safety functions,
i.e. where a fault or failure would result in a risk of injury. In any application where the
incorrect operation of the brake release mechanism could result in injury, independent
Applications
protection devices of proven integrity must also be incorporated.
Security
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.
Diagnostics
1.14 Electromagnetic compatibility (EMC)
Installation instructions for a range of EMC environments are provided in the relevant
Power Installation Guide. If the installation is poorly designed or other equipment does
not comply with suitable standards for EMC, the product might cause or suffer from
Advanced
features
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 drive’s 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.
information
Safety
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
Introduction
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
Mechanical Electrical
installation installation
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).
Getting
started
Figure 2-1 SM-Ethernet
Protocols
Web page FTP/custom
basics pages
Applications
The SM-Ethernet can be identified by:
Security
1. The label located on the underside of the Solutions Module.
Diagnostics
Solutions Module
name
Date code Firmware
Advanced
version
features
SM-Ethernet
1736
Firmware: 02.00.02
reference
Hardware
Quick
Issue: 05.00
issue Approvals
number
Ser No : 8000001001
MAC: 00:00:1E:06:C8:2B
Glossary of
terms
Serial
number
MAC Address
Index
2. The color coding across the front of the Solutions Module. SM-Ethernet being beige.
Safety
Before installing or removing a Solutions Module in any drive, ensure the AC supply has
Introduction
been disconnected for at least 10 minutes and refer to Chapter 1 Safety information on
page 7. If using a DC bus supply ensure this is fully discharged before working on any
WARNING drive or Solutions Module.
Mechanical Electrical
installation installation
3.1 General installation
The installation of a Solutions Module is illustrated in Figure 3-1.
Figure 3-1 Fitting a Solutions Module
Getting
started
2
Protocols
Web page FTP/custom
basics pages
Applications
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.
Security
Diagnostics
Advanced
features
reference
Quick
Glossary of
terms
Index
Figure 4-1 shows an overview of the module connections and indicators. The default
mode for the RJ45 is crossover.
Spade
connector
Link / Activity Module status
information
Safety
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.
Introduction
4.3 Module grounding
SM-Ethernet is supplied with a grounding tag on the module that should be connected
Mechanical Electrical
installation installation
to the closest possible grounding point using the minimum length of cable. This will
greatly improve the noise immunity of the module.
4.5 Cable
Getting
It is recommended that a minimum specification of CAT5e is installed on new
started
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.
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
basics
generally offer the same degree of noise immunity as equipment intended for industrial
use.
pages
4.6 Maximum network length
The main restriction imposed on Ethernet cabling is the length of a single segment of
Applications
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
Security
Data rate Maximum trunk length
Type Of Cable
(bit/s) (m)
Diagnostics
Copper - UTP/STP CAT 5 10M 100
Copper - UTP/STP CAT 5 100M 100
fiber Optic - Multi-mode 10M 2000
Advanced
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
Glossary of
used on the network. The use of wireless networking products is not recommended for
terms
information
Safety
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
Introduction
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
Mechanical Electrical
installation installation
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.
Getting
started
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.
Protocols
Web page FTP/custom
basics pages
SecurityApplications
cross over cable
Diagnostics
NOTE When purchasing network cables it is recommended that a different color (e.g. pink) is
Advanced
features
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 auto-
reference
Quick
detect 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 97.
Glossary of
terms
NOTE 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.
Index
Non-crossover cable
Switch
Non-crossover cable
Non-crossover cables
Switch
Safety
5.1 Minimum software versions required for Ethernet
Introduction
Table 5.1 below, lists the minimum versions of software required for Ethernet
communication.
Mechanical Electrical
installation installation
Table 5.1 Required software versions for communication over Ethernet
Product Software Version
Unidrive SP Version 01.06.00 or later
Commander SK Version 01.06.00 or later
Digitax ST Version 01.00.00 or later
Affinity Version 01.00.00 or later
Mentor MP Version 01.00.00 or later
Getting
started
SM-Applications Version 01.04.05 or later
SM-Ethernet Version 01.02.00 or later
OPC Server Version 03.01.00 or later
Protocols
CTScope Version 01.00.00 or later
SyPTPro Version 02.01.00 or later
CTSoft Version 01.05.00 or later
pages
equipment. When designing an industrial network you must carefully consider the
topology and data traffic on the network to avoid potential problems.
Applications
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
Security
network.
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
Advanced
features
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 21). Generally devices on different subnets can only
reference
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
Index
NOTE 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.
information
Safety
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
Introduction
governing body (InterNIC) when using them publicly (on the Internet) to avoid
duplication.
5.6.2 Class B addresses
Mechanical Electrical
installation installation
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.
Getting
started
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.
Protocols
5.6.4 Class D & E addresses
These addresses are reserved for multicasting and experimental use.
pages
numbers are required to allow communication on Ethernet using TCP/IP.
Applications
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
Diagnostics
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
Advanced
255.255.255.0. This alternative notation indicates the number of bits representing the
features
subnet part of the address, starting from the most significant bit.
Figure 5-1 shows how the IP address and subnet mask are used to determine the
subnet address and the host address.
Index
w x y z
IP Address 192 168 0 1
bit-wise AND
w x y z
Subnet Mask 255 255 255 0
w x y z
Host
Subnet Address 192 168 0 0
Address
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 74.
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.
information
Safety
Start
Introduction
Connect all drives
PING all drives
together using
from a command
approved cable / See Chapter 4 See Chapter 5
prompt to test
Mechanical Electrical
connectors /
installation installation
connections
switches
Getting
started
Ensure segment
lengths no longer Save module
See Chapter 4 See Chapter 5
than maximum settings on drive.
Protocols
limits.
basics
are no circular additional features
systems require See Chapter 7
loops between using a web
devices/switches specialist hardware. browser
pages
END
Ensure the correct
cable types are See Chapter 4
Applications
used
A dedicated
Security
Ethernet cable
Perform cable
tester Is
tests
recommended.
Diagnostics
Configure the IP
address, subnet
mask and default
See Chapter 5
Advanced
features
gateway
Any changes
made will require a
module reset to be
activated
Pr MM.32 = ON
reference
Quick
Ensure PC is on
the same subnet
or the default See Chapter 5
gateway on the
Index
NOTE When DHCP is enabled (see section 5.15 DHCP (Dynamic Host Configuration
Protocol) on page 27) the whole IP address is acquired from the DHCP server and writ-
ten to the parameters in the drive during start-up. This could take several minutes de-
pending on server availability and network status.
5.11.1 SM-Ethernet IP address Wip
SM-Ethernet IP address Wip
Default 192
Pr MM.10 Range 0 to 255
Access RW
This is the most significant octet of SM-Ethernet’s IP address. When using DHCP this
will be updated from the DHCP server.
information
Safety
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.
Introduction
Figure 5-3 The subnet mask
SM-Ethernet
Wsubnet Xsubnet Ysubnet Zsubnet
Mechanical Electrical
installation installation
subnet mask
Pr MM.14 Pr MM.15 Pr MM.16 Pr MM.17
NOTE 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 255
Protocols
Pr MM.14 Range 0 to 255
Access RW
basics
this will be updated from the DHCP server.
pages
SM-Ethernet IP address Xsubnet
Default 255
Applications
Pr MM.15 Range 0 to 255
Access RW
This is the second most significant octet of SM-Ethernet’s IP subnet mask. When using
DHCP this will be updated from the DHCP server.
Security
5.12.3 SM-Ethernet IP subnet mask Ysubnet
Diagnostics
SM-Ethernet IP subnet mask Ysubnet
Default 255
Pr MM.16 Range 0 to 255
Advanced
Access RW
features
This is the third most significant octet of SM-Ethernet’s IP subnet mask. When using
DHCP this will be updated from the DHCP server.
reference
Default 0
terms
SM-Ethernet
subnet mask
Wgateway Xgateway Ygateway Zgateway
Pr MM.18 Pr MM.19 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.
NOTE 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.
Safety
SM-Ethernet IP default gateway Zgateway
Default 254
Introduction
Pr MM.21 Range 0 to 255
Access RW
This is the least significant octet of SM-Ethernet’s default gateway address. When using
Mechanical Electrical
installation installation
DHCP this will be updated from the DHCP server.
Getting
started
Access 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.
Protocols
Table 5.4 SM-Ethernet baud rate
Pr MM.04 baud rate
basics
1 10Mbs
2 100Mbs
pages
NOTE This parameter should normally be left in the auto detect state.
Applications
5.15 DHCP (Dynamic Host Configuration Protocol)
5.15.1 DHCP enable
DHCP enable
Security
Default 0
Pr MM.05 Ranges 0 to 1
Access RW
Diagnostics
This parameter determines if the module gets it’s 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
Advanced
features
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.
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.
NOTE On Commander SK drives, Pr 00.00 is not available, a different menu number must be
used, e.g. Pr 01.00.
information
Safety
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.
Introduction
To store drive parameters:
• Set Pr MM.00 to 1000. (See notes).
• Press the red RESET button.
Mechanical Electrical
installation installation
The drive will store all parameters (except Menu 20), but the operation of the SM-
Ethernet 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 in-
stalled. See the SM-APPLICATIONS/SM-APPLICATIONS LITE User Guide documen-
tation for more information. If the host drive is running on a low voltage supply only or
Getting
has a UU trip active the value 1001 must be used instead of 1000.
started
NOTE On Commander SK drives, Pr 00.00 is not available, a different menu number must be
used, e.g. Pr 01.00.
Protocols
Web page FTP/custom
basics pages
SecurityApplications
Diagnostics
Advanced
features
reference
Quick
Glossary of
terms
Index
NOTE 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.
information
Safety
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.
Introduction
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/
Mechanical Electrical
custom pages on page 75.
installation installation
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).
Getting
started
The standard web pages provide access to the following features:
• Parameters.
• Protocol configuration.
Protocols
• Network configuration.
• General configuration.
• Help pages providing guidance on use.
pages
6.4 FTP
FTP will allow custom web page changes on SM-Ethernet. If an appropriate network
Applications
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:
Security
• Web page languages
• Custom web pages
Diagnostics
See Chapter 8 FTP/custom pages on page 75 for more details.
SNTP allows synchronisation of SM-Ethernet’s 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
Glossary of
NOTE Access to SM-Applications using the inter-option communication channel will extend
these times.
NOTE These network performance timings are not guaranteed and will vary depending on the
network configuration.
NOTE The performance values stated above will also be slower on Commander SK due to the
hardware differences of the Commander SK.
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 35.
NOTE The user must be logged in as an “Administrator” or “Super user” to change the config-
uration settings.
information
Safety
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
Introduction
indicate “Connected”.
6.7.4 Advanced EDS File
If the advanced EDS file is disabled, then the identity object will only contain the product
Mechanical Electrical
installation installation
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
Getting
started
page 49.
6.7.5 Requested Packet Interval (RPI) timeout trip
Protocols
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/
pages
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.
Applications
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
Security
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
Diagnostics
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
Advanced
features
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
reference
Quick
NOTE The trigger parameter is a parameter that is used by SM-Ethernet to allow cyclic param-
eters to be sampled and is configured from the EtherNet/IP sub-menu of the PROTO-
Glossary of
terms
COLS menu. This parameter value will be set to zero when either the SM-Ethernet
module or the drive is reset.
Index
NOTE The trigger parameter is a parameter that is used by SM-Ethernet to allow cyclic param-
eters to be written and is configured from the EtherNet/IP sub-menu of the PROTO-
COLS 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
information
Safety
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
Introduction
6.7.26 AC/DC Drive object on page 62.
The Control Techniques object (class 100 or 0x64) provides access to all drive
parameters using the following format.
Mechanical Electrical
installation installation
Class code: 100 (0x64)
Instance: Menu
Attribute: Parameter
Read code: 14 (0x0E) Get_Attribute_Single
Write code: 16 (0x10) Set_Attribute_Single
NOTE An instance value of 0 is not a valid value in this context, therefore an instance value of
Getting
started
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 66.
Protocols
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
pages
NOTE Some PLCs provide the option of transmitting a configuration assembly object. The SM-
Ethernet module does not use a configuration object, if one is required by the PLC con-
Applications
figuration tool, then instance 1 should be specified with a length of 0 bytes.
NOTE 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
Security
section 6.7.10 Configuring SM-Ethernet cyclic parameters on page 35.
Diagnostics
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
Advanced
mapping configuration, open the web page “EtherNet/IP” from the PROTOCOLS menu,
features
and select the appropriate assembly object, from here the required parameters may be
mapped to the selected assembly object. Figure 6-1 on page 36, shows a sample web
page configuration screen for mapping parameters.
reference
Quick
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
Glossary of
NOTE 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
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.
information
Safety
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”.
Introduction
NOTE Although the Allen Bradley PLCs are mentioned in this document, this does not repre-
sent an endorsement of any particular PLC type or PLC manufacturer.
When configuring the PLC for cyclic communication with SM-Ethernet, the length of
Mechanical Electrical
installation installation
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
Getting
started
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.
Protocols
Figure 6-2 PLC configuration
pages
Length of each data word.
Applications
SM-Ethernet IP address.
Security
Diagnostics
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
Advanced
features
NOTE Conformance with the pre-defined assembly objects specification can only be guaran-
teed if the speed reference configuration of the drive has not been changed from the de-
fault settings. For information on setting default values, refer to the appropriate drive user
guide.
b7 b6 b5 b4 b3 b2 b1 b0
FaultRst RunFwd
information
Safety
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.
Introduction
Table 6.6 Drive control word bit functions
Bit Function Equivalent parameter
Mechanical Electrical
installation installation
0 Drive enable. Pr 6.15
1 Run forward. Pr 6.30
2 Jog forward. Pr 6.31
3 Run reverse. Pr 6.32
4 Forward/reverse. Pr 6.33
5 Run. Pr 6.34
6 Not stop. Pr 6.39
Getting
started
7 Auto/manual. N/A
8 Analog/preset reference. Pr 1.42
9 Jog reverse. Pr 6.37
Protocols
10 Reserved. N/A
11 Reserved. N/A
12 Trip drive. N/A
pages
The speed reference word utilises 2 bytes (16 bits) as shown below.
Applications
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 62.
The PLC or scanner must be configured for 4 output bytes (or 2 output words) if this
features
b7 b6 b5 b4 b3 b2 b1 b0
NetRef NetCtrl FaultRst RunRev RunFwd
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.
NOTE For information on the drive control word see Table 6.6 Drive control word bit
functions on page 39.
b7 b6 b5 b4 b3 b2 b1 b0
SpeedRef (low byte)
For more information on the setting of the speed reference see section 6.7.26 AC/DC
Drive object on page 62.
information
Safety
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
Introduction
b7 b6 b5 b4 b3 b2 b1 b0
Mechanical Electrical
installation installation
FaultRst RunFwd
Getting
started
trip state.
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.
Protocols
NOTE For information on the drive control word see Table 6.6 Drive control word bit
functions on page 39.
pages
b15 b14 b13 b12 b11 b10 b9 b8
SpeedRef (high byte)
Applications
b7 b6 b5 b4 b3 b2 b1 b0
SpeedRef (low byte)
For more information on the setting of the speed reference see section 6.7.26 AC/DC
Drive object on page 62.
Security
Torque reference (TorqueRef)
Diagnostics
The torque reference word utilises 2 bytes (16 bits) as shown below.
b7 b6 b5 b4 b3 b2 b1 b0
TorqueRef (low byte)
reference
For more information on the setting of the torque reference see section 6.7.26 AC/DC
Quick
b7 b6 b5 b4 b3 b2 b1 b0
NetRef NetCtrl FaultRst RunRev RunFwd
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.
NOTE For information on the drive control word see Table 6.6 Drive control word bit
functions on page 39.
b7 b6 b5 b4 b3 b2 b1 b0
SpeedRef (low byte)
For more information on the setting of the speed reference see section 6.7.26 AC/DC
Drive object on page 62.
Safety
The torque reference word utilises 2 bytes (16 bits) as shown below.
Introduction
TorqueRef (high byte)
b7 b6 b5 b4 b3 b2 b1 b0
Mechanical Electrical
installation installation
TorqueRef (low byte)
For more information on the setting of the torque reference see section 6.7.26 AC/DC
Drive object on page 62.
Getting
started
assembly object is to be used.
Protocols
Data word Function
Word 0 Basic status word.
Word 1 Speed feedback (SpeedActual).
pages
b15 b14 b13 b12 b11 b10 b9 b8
Applications
b7 b6 b5 b4 b3 b2 b1 b0
Running1
Faulted
(Fwd)
Security
The individual bit functions are described as follows:
Diagnostics
Indicates whether the drive is OK or tripped
b0 Faulted
(0=OK, 1=Tripped).
Running1 Indicates if the drive is running in the forward direction
b2
(Fwd) (0=False, 1=True).
Advanced
features
b7 b6 b5 b4 b3 b2 b1 b0
SpeedActual (low byte)
For more information on the speed feedback see section 6.7.26 AC/DC Drive object on
Index
page 62.
b7 b6 b5 b4 b3 b2 b1 b0
At RefFrom CtrlFrom Running2 Running1
Ready Warning Faulted
Reference Net Net (Rev) (Fwd)
The DriveState byte returns a code to indicate the operating state of the drive as shown
in Table 6.12 below.
information
Safety
Name Bit Description
b0 Indicates whether the drive is OK or tripped.
Faulted 0=OK (Pr 10.01=1).
Introduction
1=Tripped (Pr 10.01=0).
Warning b1 Indicates if one of the drive alarms is active.
Running1 Indicates if the drive is running in the forward direction.
b2
(Fwd) 0=False, 1=True.
Mechanical Electrical
installation installation
Running2 Indicates if the drive is running in the reverse direction.
b3
(Rev) 0=False, 1=True.
The ‘Ready’ bit is set depending on which state the drive is in.
Ready = True.
Ready b4 Enabled = True.
Stopping = True.
All others = False.
Indicates if the drive is being controlled from the ‘Drive Control Word’.
Getting
started
CtrlFromNet b5
0=False, 1=True.
Indicates if the speed reference is derived from Pr 1.21.
RefFromNet b6 0=False (Pr 1.50<>1 OR Pr 1.49<>3).
Protocols
1=True (Pr 1.50=1 AND Pr 1.49=3).
Indicates if the drive speed has reached the set reference.
AtReference b7 0=False (Pr 10.06=0).
1=True (Pr 10.06=1).
pages
b15 b14 b13 b12 b11 b10 b9 b8
SpeedActuall(high byte)
Applications
b7 b6 b5 b4 b3 b2 b1 b0
SpeedActual (low byte)
For more information on the speed feedback see section 6.7.26 AC/DC Drive object on
Security
page 62.
Diagnostics
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.
Advanced
features
b7 b6 b5 b4 b3 b2 b1 b0
Running1
Faulted
(Fwd)
b7 b6 b5 b4 b3 b2 b1 b0
SpeedActual (low byte)
For more information on the speed feedback see section 6.7.26 AC/DC Drive object on
page 62.
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 62.
information
Safety
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
Introduction
DriveState
b7 b6 b5 b4 b3 b2 b1 b0
Mechanical Electrical
installation installation
At RefFrom CtrlFrom Running2 Running1
Ready Warning Faulted
Reference Net Net (Rev) (Fwd)
The DriveState byte returns a code to indicate the operating state of the drive as shown
in Table 6.16.
Getting
started
1 00000001 Startup This state is skipped over on CT drives.
2 00000010 Not_Ready Inhibit.
Protocols
3 00000011 Ready Ready.
Run or Stop (Stop is only enabled by default in
4 00000100 Enabled
Servo mode).
5 00000101 Stopping Deceleration or Injection.
pages
0 00000000 Vendor Specific
Regen Active, etc.
The individual bits of the low byte of the extended status word are described in Table
Applications
6.17 Extended status word (low byte) on page 48.
Security
Diagnostics
Advanced
features
reference
Quick
Glossary of
terms
Index
b7 b6 b5 b4 b3 b2 b1 b0
SpeedActual (low byte)
For more information on the speed feedback see section 6.7.26 AC/DC Drive object on
page 62.
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 62
information
Safety
The Object Model has the following object classes present.
Table 6.18 Supported Objects
Introduction
No. of
Object Class Class Code Effect
Instances
Mechanical Electrical
installation installation
Defines the motor data
Motor Data 0x28 (4010) 2 (For AC motors, see Table 6.25 on page 54)
(For DC motors, see Table 6.27 on page 55)
Provides drive control and monitoring
Control Supervisor 0x29 (4110) 1 information
(See Table 6.28 on page 58)
Provides information on the drive running
AC/DC Drive 0x2A (4210) 1 state
(See Table 6.32 on page 62)
Getting
started
Control Techniques 0x64 (10010) Provides an interface to drive parameters
45
Group (See Table 6.34 on page 66)
Provides the mechanism to configure the
Protocols
TCP/IP Interface 0xF5 (24510) 1 TCP/IP interface
(See Section 6.7.28)
Maintains link specific counters and status
Ethernet Link 0xF6 (24610) 1 information
pages
The identity object provides identification of and general information about the device.
Applications
Table 6.19 Identity object
Attribute Access Name Data Type
1 Get VendorID UINT
Security
2 Get DeviceType UINT
3 Get ProductCode UINT
4 Get Revision USINT
Diagnostics
6 Get SerialNumber UDINT
7 Get ProductName SHORT_STRING
Advanced
Vendor ID
features
Name: VendorID
Class 0x01 Default 0x101 (25710)
reference
Quick
Returns the device type code. The following codes are used:
Product code
Name: ProductCode
Class 0x01 Default See below
Instance 0x01 Data Type UINT
Attribute 0x03 Access 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 b9 b8 b7 b6 b5 b4 b3 b2 b1 b0
Product Major Revision Mode 0
information
The mode value is defined as follows:
Safety
Mode Description
Introduction
AC Drive (Type: 0x02) DC Drive (Type: 0x13)
0 Commander SE Reserved
1 Open Loop Reserved
Mechanical Electrical
installation installation
2 Closed Loop Vector Mentor MP
3 Servo Reserved
4 Regen Reserved
If an advanced EDS file is used then the product code is calculated as shown in
Getting
started
Table 6.21 Advanced product code below.
Table 6.21 Advanced product code
Protocols
b15 b14 b13 b12 b11 b10 b9 b8 b7 b6 b5 b4 b3 b2 b1 b0
Product Major Revision + Slot Mode Slot X Slot Y
basics
Major Revision + Slot (b12 to b9)
The value contains the major revision number of the drive firmware and the slot that
pages
the SM-Ethernet module is installed in.
The value returned will be calculated from the formula:
#11.29 * 3 + (Slot -1)
Applications
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,
Security
the value returned will be 5.
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)
Glossary of
terms
For the option module ID codes see Table 6.22 Option modules ID codes on
page 52).
Index
NOTE The advanced EDS file mode is not supported on Commander SK.
Revision
Name: Revision
Class 0x01 Default N/A
Instance 0x01 Data Type ARRAY of USINT
Attribute 0x04 Access 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 53.
Safety
b15 b14 b13 b12 b11 b10 b9 b8 b7 b6 b5 b4 b3 b2 b1 b0
Minor Revision 0 12710 (All bits set to 1)
Introduction
The minor revision returned will be calculated from the formula:
#11.29 Mod 100 + 1.
Mechanical Electrical
installation installation
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.
Getting
started
If an advanced EDS file is used then the revision number is calculated as shown below.
Table 6.24 Advanced revision
Protocols
b15 b14 b13 b12 b11 b10 b9 b8 b7 b6 b5 b4 b3 b2 b1 b0
Sub-version 0 Minor Revision
basics
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
pages
the decimal point).
e.g. For a value of “1.09” in Pr 11.29, the minor revision returned is 10.
Applications
Sub-version
The sub-version returned will be calculated from the formula:
Security
#11.34 + 1.
e.g. For a value of “1” in Pr 11.34, the sub-version returned is 2.
Diagnostics
Serial Number
Name: SerialNumber
Class 0x01 Default N/A
Advanced
features
address is set during production, and cannot be changed. This value is also displayed in
Pr MM.35.
Glossary of
NOTE This can be used to find the complete MAC address of the module by combining the
terms
Name: ProductName
Class 0x01 Default SM-Ethernet
Instance 0x01 Data Type SHORT_STRING
Attribute 0x07 Access 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 SM-
Ethernet returns the string “SM-Ethernet”.
Introduction
Attribute ID Name Access Instance 1 Instance 2
0x03 (310) MotorType (*) Get/Set Pr 64.13 Pr 64.14
Mechanical Electrical
installation installation
0x07 (710) RatedVoltage Get/Set Pr 5.09 Pr 21.09
Getting
started
(scaled to 100mA units) (scaled to 100mA units)
0x11 (1710) Get
MinFieldCur
Set
Pr 5.69 will be written with Pr 5.69 will be written with
Protocols
the appropriate instance the appropriate instance
value, depending on which value, depending on which
motor map is selected. motor map is selected.
0x12 (1810) RatedFieldVolt Get/Set Pr 5.73 Pr 21.23
basics
0x64 (10010) Motor2Select
Set Pr 11.45 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 on page 54).
pages
Motor type
Applications
Name: MotorType1
Class 0x28 Default 7
Instance 0x01 Data Type USINT
Attribute 0x03 Access Get/Set
Security
Returns or sets the motor type to be used by the drive for instance 1.
Diagnostics
Name: MotorType2
Class 0x28 Default 7
Instance 0x02 Data Type USINT
Attribute 0x03 Access Get/Set
Advanced
features
Returns or sets the motor type to be used by the drive for instance 2.
reference
Quick
Glossary of
terms
Index
Name: RatedCurrent1
Class 0x28 Default Pr 5.07 / 10
Instance 0x01 Data Type USINT
Attribute 0x06 Access Get/Set
Returns or sets the rated motor current in Amps for instance 1. This attribute is linked to
Pr 5.07.
Set Pr 5.07 = RatedCurrent1 * 10.
Get RatedCurrent1 = Pr 5.07 / 10.
Name: RatedCurrent2
Class 0x28 Default Pr 21.07 / 10
Instance 0x02 Data Type USINT
Attribute 0x06 Access Get/Set
Returns or sets the rated motor current in Amps for instance 2. This attribute is linked to
Pr 21.07.
Set Pr 21.07 = RatedCurrent2 * 10.
Get RatedCurrent2 = Pr 21.07 / 10.
Rated voltage
Name: RatedVoltage1
Class 0x28 Default Pr 5.09
Instance 0x01 Data Type USINT
Attribute 0x07 Access Get/Set
Returns or sets the rated motor voltage in Volts for instance 1. This attribute is linked to
Pr 5.09.
Name: RatedVoltage2
Class 0x28 Default Pr 21.09
Instance 0x02 Data Type USINT
Attribute 0x07 Access Get/Set
Returns or sets the rated motor voltage in Volts for instance 2. This attribute is linked to
Pr 21.09.
information
Safety
Name: RatedFreq1
Class 0x28 Default Pr 5.06 / 10
Introduction
Instance 0x01 Data Type USINT
Attribute 0x09 Access Get/Set
Returns or sets the rated motor frequency in Hertz for instance 1. This attribute is linked
Mechanical Electrical
installation installation
to Pr 5.06.
Set Pr 5.06 = RatedFreq1 * 10.
Get RatedFreq1 = Pr 5.06 / 10.
Name: RatedFreq2
Class 0x28 Default Pr 21.06 / 10
Getting
started
Instance 0x02 Data Type USINT
Attribute 0x09 Access Get/Set
Returns or sets the rated motor frequency in Hertz for instance 2. This attribute is linked
Protocols
to Pr 21.06.
Set Pr 21.06 =RatedFreq2 * 10.
Get RatedFreq2 = Pr 21.06 / 10.
Name: BaseSpeed1
pages
Class 0x28 Default Pr 5.08
Instance 0x01 Data Type USINT
Applications
Attribute 0x0F Access Get/Set
Returns or sets the base speed of the motor in RPM for instance 1. This attribute is
linked to Pr 5.08.
Security
Name: BaseSpeed2
Class 0x28 Default Pr 21.08
Instance 0x02 Data Type USINT
Diagnostics
Attribute 0x0F Access 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: Motor2Select
reference
Quick
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
RunFwd
Name: RunFwd
Class 0x29 Default N/A
Instance 0x01 Data Type USINT
Attribute 0x03 Access Get/Set
Set to 1 to run the drive in the forward direction.
Get/Set Pr 6.42 (bit 1).
RunRev
Name: RunRev
Class 0x29 Default N/A
Instance 0x01 Data Type USINT
Attribute 0x04 Access Get/Set
Set to 1 to run the drive in the reverse direction.
Get/SetPr 6.42 (bit 3).
information
Safety
Name: NetCtrl
Class 0x29 Default N/A
Introduction
Instance 0x01 Data Type USINT
Attribute 0x05 Access Get/Set
Switches between terminal and fieldbus control.
Mechanical Electrical
installation installation
Get/SetPr 6.42 (bit 7)
0 = Terminal control.
1 = Fieldbus control.
State
Name: State
Class 0x29 Default N/A
Getting
started
Instance 0x01 Data Type USINT
Attribute 0x06 Access Get
This returns a code to indicate the current running state of the drive as shown in
Protocols
Table 6.29 below.
Table 6.29 Control Supervisor state attribute
Code State Description
pages
4 Enabled Run or Stop (Stop is only enabled by default in Servo mode)
5 Stopping Decelerating or DC injection braking
ACUU (AC Under Voltage) - this will only occur if mains loss
Applications
6 Fault_Stop
is enabled
7 Faulted Tripped
All other DriveType states, e.g. Scan, Orienting, Regen
0 Vendor Specific
Active, etc.
Security
RunningFwd
Diagnostics
Name: RunningFwd
Class 0x29 Default N/A
Instance 0x01 Data Type USINT
Advanced
features
RunningRev
Name: RunningRev
Glossary of
terms
Name: Ready
Class 0x29 Default N/A
Instance 0x01 Data Type USINT
Attribute 0x09 Access 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 State Ready state
3 Ready True
4 Enabled True
5 Stopping True
All others False
Faulted
Name: Faulted
Class 0x29 Default N/A
Instance 0x01 Data Type USINT
Attribute 0x0A Access 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: Warning
Class 0x29 Default N/A
Instance 0x01 Data Type USINT
Attribute 0x0B Access Get
Indicates that one of the drive alarms is active.
Get Pr 10.19.
FaultRst
Name: FaultRst
Class 0x29 Default N/A
Instance 0x01 Data Type USINT
Attribute 0x0C Access Get/Set
Resets the drive from a tripped condition.
Sets Pr 10.38 to 100 on a 0 to 1 transition.
information
Safety
Name: FaultCode
Class 0x29 Default N/A
Introduction
Instance 0x01 Data Type USINT
Attribute 0x0D Access Get
The fault code attribute will return the ODVA fault code as follows:
Mechanical Electrical
installation installation
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.
Getting
started
Table 6.31 Control Supervisor fault code attribute
ODVA Fault ODVA Fault
Drive Fault Code Drive Fault Code
Code Code
Protocols
1 0x3220 20 0x2310
2 0x3210 21 0x4300
3 0x2300 26 0x5112
pages
CtrlFromNet
Name: CtrlFromNet
Applications
Class 0x29 Default N/A
Instance 0x01 Data Type USINT
Attribute 0x0F Access 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: DriveEnable
Class 0x29 Default N/A
Advanced
features
RunRev attributes to control the drive. RunFwd and RunRev will have no effect if
DriveEnable is not set to 1.
Get/Set Pr 6.42 bit 0.
Glossary of
terms
NOTE The external hardware enable signal must also be present before the drive will enter the
Ready state.
Index
NOTE 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: AtReference
Class 0x2A Default N/A
Instance 0x01 Data Type USINT
Attribute 0x03 Access 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: NetRef
Class 0x2A Default N/A
Instance 0x01 Data Type USINT
Attribute 0x04 Access Get/Set
Selects the source of the speed reference.
Get/SetPr 6.42 bit 8
0 = analog speed reference.
1 = digital speed reference.
Introduction
DriveMode
Name: DriveMode
Class 0x2A Default N/A
Mechanical Electrical
installation installation
Instance 0x01 Data Type USINT
Attribute 0x06 Access 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.
Getting
started
Access Value Mode (Pr 4.11) Current drive mode (Pr 11.31)
1 Open Loop Speed (0) Open loop (1)
2 Closed Loop Speed (0) Closed loop vector (2)
Protocols
2 Closed Loop Speed (0) Servo (3)
2 Closed Loop Speed (0) Mentor MP
3 Torque Control (1) Open loop (1)
basics
Get
3 Torque Control (1) Servo (3)
3 Torque Control (1) Mentor MP
0 Don’t care Regen (4)
pages
User defined
Torque control with speed override (2) OR
0 Don’t care
Coiler/uncoiler mode (3) OR
Applications
Speed control with torque feed-forward (4)
0 Invalid Attribute Value (0x09) Don’t care
1 Open Loop Speed (0) Open loop (1)
Closed loop vector (2) OR
Security
Servo (3) OR
1 Device State Conflict (0x10)
Regen (4) OR
Mentor MP
Diagnostics
Closed loop vector (2) OR
2 Closed Loop Speed (0) Servo (3) OR
Set
Mentor MP
Open loop (1) OR
2 Device State Conflict (0x10)
Advanced
Regen (4)
features
Mentor MP
Quick
NOTE Pr 11.31 will never be changed by setting the DriveMode attribute. An error (0x10) will
terms
be generated if the requested DriveMode value does not correspond to the current
DriveType operating mode.
Index
Name: SpeedActual
Class 0x2A Default N/A
Instance 0x01 Data Type USINT
Attribute 0x07 Access 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 Pr 5.04 (Open Loop).
Get Pr 3.02 (Closed Loop or Servo).
SpeedRef
Name: SpeedRef
Class 0x2A Default N/A
Instance 0x01 Data Type USINT
Attribute 0x08 Access 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: TorqueActual
Class 0x2A Default N/A
Instance 0x01 Data Type USINT
Attribute 0x0B Access 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 0x2A Default N/A
Instance 0x01 Data Type USINT
Attribute 0x0C Access 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.
information
Safety
Name: RefFromNet
Class 0x2A Default
Introduction
Instance 0x01 Data Type USINT
Attribute 0x1D Access Get
Indicates the source of the speed reference.
Mechanical Electrical
installation installation
TRUE if Pr 1.49 = 3 and Pr 1.50 = 1.
FALSE otherwise.
Getting
started
Protocols
Web page FTP/custom
basics pages
SecurityApplications
Diagnostics
Advanced
features
reference
Quick
Glossary of
terms
Index
information
Safety
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
Introduction
address, network mask and gateway address.
Mechanical Electrical
installation installation
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.
Getting
started
Protocols
Web page FTP/custom
basics pages
SecurityApplications
Diagnostics
Advanced
features
reference
Quick
Glossary of
terms
Index
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.
Issue: 7
navigation.
Modbus Scheduled
Summary Email EtherNet/IP
TCP/IP Events
Communication User Menu Backup Reset
Advanced Parameter
Drive Menus Editor Summary Modules
Editor File
69
The menu structure on SM-Ethernet is logically grouped by function to allow for ease of
information
Safety
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 SM-
Introduction
Ethernet. 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.
Mechanical Electrical
installation installation
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
Getting
started
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
Protocols
NOTE
less than the minimum length allowed for a password.
Diagnostics
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:
Advanced
• 5 minutes
• 15 minutes
reference
• 30 minutes
Quick
• 60 minutes
• Disabled (‘Read Only’ and ‘General User’ accounts only)
Glossary of
terms
Index
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 .
information
Safety
Command Description Example Result
Exclusively ORs
the value of
Introduction
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.
Mechanical Electrical
installation installation
ANDs the value of
Pr 20.20 with the
AND destination value with source
&= #20.20 &= #20.21 value of Pr 20.21
value.
and writes the
result to Pr 20.20.
ORs the value of
Pr 20.20 with the
OR destination value with source
|= #20.20 |= #20.21 value of Pr 20.21
value.
and writes the
Getting
started
result to Pr 20.20.
Negate function (optional)
Negates the source value
Protocols
Writes Pr 20.20
Note: Cannot be used without the with a value equal,
- source parameter specified. #20.20 = - #20.21 but of opposite
polarity, to the
basics
or “--” operators.
Source parameter (required unless “++” or “--” operators used)
Writes the value of
Represents the source menu and
#mm.pp #20.20 = #20.21 Pr 20.21 into
pages
parameter.
Pr 20.20
n Represents a number to be used for #20.20 = 1500
the source value. Writes the value
Applications
or or “1500” into
Note: Can be specified in decimal or Pr 20.20
0xn hexadecimal. #20.20 = 0x05DC
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.
Advanced
Modbus TCP/IP - Displays and allows editing of the TCP/IP settings for Modbus
features
TCP/IP.
Email - Allows setting up of event triggered e-mails and configuration of the mail
server settings.
reference
Quick
mappings.
Index
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 Help
These pages provide a basic level of help on the features of the SM-Ethernet module.
7.2.9 Log-Out
This option logs the current user out of the web pages.
Safety
8.1 Introduction
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.
Mechanical Electrical
installation installation
Figure 8-1 Custom web page
Getting
started
Protocols
Web page FTP/custom
basics pages
Applications
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
Diagnostics
on the drive you must connect to the drive using an FTP program. Most popular FTP
programs should be suitable for this purpose. Advanced
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.
reference
Quick
• Enter the user name and password for an Administrative account. See section
10.4 Account management on page 88.
• Select active mode.
Index
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 SM-
Ethernet, 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.
• images - contains the images for the custom pages, these may be added to if required.
NOTE 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 con-
nection.
information
Safety
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:
Introduction
• 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.
Mechanical Electrical
installation installation
• 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 module’s 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
Getting
started
10.6 Security levels on page 89).
Protocols
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,
pages
smethernet.htm for displaying and updating values. These are contained within <script>
and </script> tags as shown below:
Applications
<script>
new Light("light1", "10.1", {imageOn:"images/healthy_on.gif",
imageOff:"images/illum_off.gif"});
</script>
Security
This process is transparent to the end user and the only browser support required is
Javascript.
Diagnostics
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:
Advanced
features
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.
reference
Quick
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.
Glossary of
terms
Reading of parameters is performed in a similar way but uses the URL as follows:
NOTE To read or write the parameters you must be logged in with appropriate security access.
Safety
SM-Ethernet provides an alternative to the EIA-485 (RS-485) connections provided on
Introduction
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.
Mechanical Electrical
installation installation
• 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.
Getting
started
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
Protocols
CAUTION especially if a remote user can access the drive over Ethernet.
basics
software required for Ethernet communication.
Table 9.1 Required software versions for communication over Ethernet
pages
Product Software Version
Unidrive SP Version 01.06.00 or later
Commander SK Version 01.06.00 or later
Applications
Digitax ST Version 01.00.00 or later
Affinity Version 01.00.00 or later
Mentor MP Version 01.00.00 or later
SM-Applications Version 01.04.05 or later
Security
SM-Ethernet Version 01.02.00 or later
OPC Server Version 03.01.00 or later
Diagnostics
CTScope Version 01.00.00 or later
SyPTPro Version 02.01.00 or later
CTSoft Version 01.05.00 or later
Advanced
features
9.2 CTSoft
9.2.1 Installing CTSoft
reference
Quick
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
Glossary of
more information.
terms
Index
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 80.
Figure 9-2 Drive properties
information
Safety
Introduction
Mechanical Electrical
installation installation
Advanced
Settings
Getting
started
Protocols
Web page FTP/custom
basics
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
pages
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
Applications
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.
Security
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
Diagnostics
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 SM-
Advanced
These are accessed using the button (as shown in Figure 9-3). The Port number will
Quick
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
Glossary of
not this informs the software that a third party gateway is in use and communications via
terms
SM-Ethernet will not be possible (for a gateway example see Knowledge Base Article
COMMS024).
Index
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.
NOTE For communication to be established, the serial priority parameter Pr MM.37 must be set
to ON in SM-Ethernet.
9.3 CTScope
9.3.1 Installing CTScope
To install CTScope, follow the instructions provided with the software.
9.3.2 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 SyPTPro
9.4.1 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.
information
Safety
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
Introduction
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.
Mechanical Electrical
installation installation
Figure 9-5 illustrates these three configurations.
Figure 9-5 SyPTPro over Ethernet routing options
Getting
started
Option 1
Protocols
Web page FTP/custom
basics
Option 2
pages
Applications
Ethernet
Option 3
Security
Diagnostics
Advanced
features
reference
Quick
Glossary of
terms
Figure 9-6, below, will be displayed. If the current protocol is not set to “CT-TCP/IP
NOTE For communication to be established, the serial priority parameter Pr MM.37 must be set
to ON in SM-Ethernet.
information
Safety
Introduction
Mechanical Electrical
installation installation
Getting
started
Protocols
5. A graphical representation of the network is displayed. Figure 9-9, below, shows the
pages
Figure 9-9 Hardware architecture
SecurityApplications
Diagnostics
Advanced
features
reference
Quick
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
Glossary of
must match the network number that the module is connected to in SyPTPro otherwise
the node may not be detected.
Index
NOTE For further information please contact the supplier of the drive.
Safety
10.1 Introduction
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.
Mechanical Electrical
installation installation
The physical system security should be enforced with acceptable user policies and
appropriate employee guidelines.
Getting
started
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.
Protocols
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
pages
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
Applications
any connections to a network should be approved by the network administrators.
Security
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.
Diagnostics
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
12.4.7 SM-Ethernet disable full access on page 108 for more information).
Quick
The global write enable Pr MM.36 is set to 0 by default. This will allow parameters to be
terms
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.
Index
NOTE A good company policy on passwords can help prevent problems occurring due to lost
passwords.
NOTE Following changes to the root account password SM-Ethernet should be reset using the
reset function on the web pages.
information
Safety
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.
Introduction
Table 10.1 Security levels
Mechanical Electrical
Edit Security Settings
installation installation
View Status Pages
Edit Configuration
Upload Firmware
View Parameters
View Home Page
Enable Features
Edit Parameters
Getting
started
Open Access Yes No No No No No No No No No No N/A
Read Only Yes Yes Yes Yes No No No No No No No Yes
General User Yes Yes Yes Yes Yes Yes No No No No No Yes
Protocols
Super User Yes Yes Yes Yes Yes Yes Yes Yes No No No No
Administrator Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes No
pages
10.6.2 Protocol authentication
Certain protocols and services will require a user to authenticate using a password and
Applications
a username. This protection is detailed in the relevant protocol section of the user guide.
Security
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
Diagnostics
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
Advanced
features
NOTE Please note that support will be limited to the setting up and networking of the drive and
not network infrastructure design.
Spade
connector
Link / Activity Module status
91
Diagnostic flow chart
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 mod-
ule 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).
information
Safety
SM-Ethernet - user allocated address
Default 0
Introduction
Pr MM.03 Range 0 to 65535
Access 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
Mechanical Electrical
installation installation
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 109).
Getting
started
Default 0
Pr MM.04 Range 0 to 2
Access RW
Protocols
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
pages
2 100Mbs
Applications
11.4.2 SM-Ethernet DHCP enable
SM-Ethernet - DHCP enable
Default 0 (disabled)
Security
Pr MM.05 Ranges 0 to 1
Access RW
If set to a 0 the module will use static IP addressing and get it’s address, subnet mask
Diagnostics
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.
Advanced
features
NOTE It is recommended that the MAC address of the SM-Ethernet module is used to allocate
the IP address when DHCP is enabled.
reference
Default 192
terms
be updated from the DHCP server. The IP address is in the format W.X.Y.Z.
information
xx.00=1001 if using a DC supply to power the drive) and activated by resetting the SM-
Safety
Ethernet module (MM.32=ON).
Introduction
SM-Ethernet - IP address Xsubnet
Default 255
Mechanical Electrical
Pr MM.15 Range 0-255
installation installation
Access RW
This is the second most significant octet of the module’s 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 SM-
Getting
started
Ethernet module (MM.32=ON).
11.4.9 SM-Ethernet IP subnet mask Ysubnet
SM-Ethernet IP subnet mask Ysubnet
Protocols
Default 255
Pr MM.16 Range 0-255
Access RW
pages
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 SM-
Ethernet module (MM.32=ON).
Applications
11.4.10SM-Ethernet IP subnet mask Zsubnet
SM-Ethernet - IP subnet mask Zsubnet
Security
Default 0
Pr MM.17 Range 0-255
Access RW
Diagnostics
This is the least significant octet of the module’s 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
Advanced
features
xx.00=1001 if using a DC supply to power the drive) and activated by resetting the SM-
Ethernet module (MM.32=ON).
Access RW
This is the most significant octet of the module’s IP default gateway address. When
using DHCP this will be updated from the DHCP server. The default gateway address is
Index
information
Safety
Pr MM.42 bit/s
0 Auto-detect.
1 full duplex.
Introduction
2 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
Mechanical Electrical
installation installation
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 0 (disabled)
Pr MM.43 Range 0 to 1
Access RW
Getting
started
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.
Protocols
Table 11.4 Crossover detection
Pr MM.43 Crossover detection
basics
1 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
pages
resetting the SM-Ethernet module (MM.32=ON) to activate the change.
Applications
SM-Ethernet Actual baud rate
Default 0
Pr MM.44 Range 0 to 2
Security
Access R
Displays the baud rate at which SM-Ethernet is operating.
Table 11.5 Actual baud rate
Pr MM.44 Actual baud rate Diagnostics
0 Baud rate not set.
Advanced
1 10Mbs.
features
2 100Mbs.
Pr MM.45 Range 0 to 2
terms
Access R
Displays the duplex mode that SM-Ethernet is currently using.
Index
information
Safety
SM-Ethernet MAC address XMAC
Default -
Introduction
Pr 61.04 Range 0 to 255
Access R
The fourth most significant byte of the MAC address. The MAC address is a unique
Mechanical Electrical
installation installation
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 -
Getting
Pr 61.05 Range 0 to 255
started
Access R
The fifth most significant byte of the MAC address. The MAC address is a unique value
Protocols
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.
pages
Pr 61.06 Range 0 to 255
Access R
Applications
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
Diagnostics
11.5.1 SM-Ethernet diagnostic information
SM-Ethernet - diagnostic information
Default N/A
Advanced
features
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
Glossary of
information
remove the power from the module, wait for the drive under-voltage (‘UU’) trip to
Safety
disappear and re-apply the power, if the problem persists then the SM-Ethernet module
should be changed.
Introduction
11.5.2 SM-Ethernet non-critical warning
SM-Ethernet Solutions Module error status
Default 0
Mechanical Electrical
installation installation
Pr MM.49 Range 0 to 255
Access 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
Protocols
Default 0
Pr MM.50 Range 0 to 255
Access R
basics
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 102.
pages
NOTE This parameter is reset to 0 if SM-Ethernet is reset.
SecurityApplications
Diagnostics
Advanced
features
reference
Quick
Glossary of
terms
Index
Safety
12.1 Email configuration
Introduction
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
Mechanical Electrical
installation installation
In order to send emails you will need the following:
• A mail server that accepts SMTP connections without a password.
• An email address for SM-Ethernet.
• The IP address of the mail server.
NOTE It is recommended that the address used is part of the standard corporate address
Getting
started
structure (i.e. [email protected]), 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.
Protocols
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
pages
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
Applications
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.
Security
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
Diagnostics
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
Advanced
select if you wish to include a parameter file in the email. Sending a parameter file in the
features
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
reference
configuration page.
Quick
Some email servers and clients may convert the '.par' file to '.dat' if this occurs you should
Glossary of
NOTE
terms
NOTE 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
Index
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.
NOTE 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.
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).
information
Safety
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
Introduction
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.
Mechanical Electrical
installation installation
• 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.
Getting
started
• 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
Protocols
following the start condition being met. The minimum recurrence interval is 100ms.
pages
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.
Do not reset or power down the drive when uploading firmware as this may result in
Applications
NOTE
data loss or corruption of the system file.
Security
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.
Diagnostics
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. Advanced
features
reference
Quick
Glossary of
terms
Index
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.
Safety
NOTE
made a backup copy of the module’s configuration you will lose all settings. All
passwords and users are deleted, the root password remains unchanged.
Introduction
12.4.3 SM-Ethernet save option parameters (backup)
SM-Ethernet - save option parameters
Mechanical Electrical
installation installation
Default OFF
Pr MM.31 Range OFF/ON
Access RW
This will save the module’s current configuration in it’s 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
Getting
started
parameters directly (i.e. Pr 61.10). In order to save these parameters in the drive’s
memory a drive save must be performed. This is required as SM-Ethernet will take it’s
operating parameters directly from the slot memory on the host drive at startup.
Protocols
NOTE To save the parameters in the drive, a value of 1000 should be entered in Pr xx.00 fol-
lowed by a drive reset (press the reset button, or toggle the reset input, or write the
value 100 to Pr 10.38).
pages
SM-Ethernet re-initialise
Default OFF
Applications
Pr MM.32 Range OFF/ON
Access RW
This will force the module to re-initialise and start up with the values contained in the slot
Security
menu of the host drive (MM.xx). This parameter will automatically reset to OFF after
completion. During this operation communications will be stopped.
The transition of MM.32 from OFF to ON may not be visible on the drive display due to
Diagnostics
NOTE
the update rate of the display.
Writing 1070 to menu Pr MM.00 (to re-initialise all option modules) may not re-initialise
Advanced
NOTE
features
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 109 for further information.
reference
Quick
Glossary of
terms
Index
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.
information
Safety
SM-Ethernet reduce serial interface priority
Default OFF
Introduction
Pr MM.37 Range OFF/ON
Access RW
NOTE It is not possible for the drive and SM-Ethernet module to support all of the available
Mechanical Electrical
installation installation
serial communication protocols simultaneously. This parameter, when set, allows SM-
Ethernet to request the highest priority (not relevant for Commander SK).
When on:
The SM-Ethernet module will request highest priority (it’s actual state is shown in Pr
6.50) and the following restrictions will be applied:
• The drive’s 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
Getting
started
server, SyPTPro and SyPTLite when communicating via the RJ45 serial
interface connector.
• An LCD keypad mounted directly to the drive will not work.
Protocols
• 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.
pages
• 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
Applications
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.
Security
NOTE For a system with multiple modules installed, the priority should be set for the module
that is receiving the incoming request.
Diagnostics
NOTE 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.
Access RW
This parameter can be used to provide logical groups for Control Techniques drives.
Glossary of
This will allow grouping independently of the IP settings. This is used in conjunction with
terms
NOTE The default port for Modbus TCP/IP communication is 502, but this may be
reconfigured using Pr 63.01 on SM-Ethernet.
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.
NOTE The rest of this section does not repeat the MBAP header for each function code for
reasons of clarity.
information
Safety
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
Introduction
that the message has not been received or the node is unable to reply.
Figure 12-2 Modbus TCP/IP- request, response, exception
Function
Mechanical Electrical
installation installation
Response Data
Code
PDU (Response)
Function
Function Data
Code
PDU (Request)
Function
Exception Data
Getting
started
Code
PDU (Exception Response)
Protocols
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.
pages
1 Transaction identifier LSB.
2 Protocol identifier MSB.
3 Protocol identifier LSB.
Applications
4 Length MSB.
5 Length LSB.
6 Unit identifier.
Security
PDU Consists of
Function code, 1 byte
Request
Function data, > 1 byte
Diagnostics
Function code, 1 byte
Response
Response data, > 1 byte
Exception Error code, 1 byte
Advanced
NOTE 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
reference
SM-Applications module installed in the lowest slot number, if this is undesireable then
Quick
the direct access parameters (menus 10x, 11x, 12x, etc) should be used.
Glossary of
terms
Index
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.
The extended data types are defined such that the type ‘00’ allows for backwards
compatibility.
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.
information
Safety
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.
Introduction
Table 12.5 Client request message Table 12.6 Server (drive) response
message
Byte Description Byte Description
Mechanical Electrical
installation installation
Server destination node
0 0 Server source node address.
address, 0 is broadcast.
1 Function code 0x03. 1 Function code 0x03.
Length of register data
2 Start register address MSB. 2
(bytes).
3 Start register address LSB. 3 Register data 0 MSB.
4 Number of 16 bit registers MSB. 4 Register data 0 LSB.
Getting
5 Number of 16 bit registers LSB. 5 Register data 1 MSB.
started
6 Register data 1 LSB.
NOTE For each byte in the PDU message, the MSB is transmitted first, followed by the LSB.
Protocols
NOTE If only one 16 bit register of a 32 bit register address is read the server returns the least
significant word.
The Modbus CRC bytes are not required when using TCP/IP due to the ethernet frame
pages
NOTE
providing the error checking.
Applications
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
Security
returned.
Table 12.7 Client request message Table 12.8 Server (drive) response
message
Diagnostics
Byte Description Byte Description
Server destination node
0 0 Server source node address.
address, 0 is broadcast.
1 Function code 0x06. 1 Function code 0x06.
Advanced
features
NOTE To write 32 bits of data to a 32 bit register address, the extended data type must be
Glossary of
NOTE For each byte in the PDU message, the MSB is transmitted first, followed by the LSB.
NOTE The Modbus CRC bytes are not required when using TCP/IP due to the ethernet frame
Index
NOTE For each byte in the PDU message, the MSB is transmitted first, followed by the LSB.
NOTE For multiple registers, the register data is transmitted in ascending order, beginning with
the start register address.
NOTE The Modbus CRC bytes are not required when using TCP/IP due to the ethernet frame
providing the error checking.
information
Safety
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.
Introduction
Table 12.11 Client request message Table 12.12 Server (drive)
response message
Byte Description Byte Description
Mechanical Electrical
installation installation
Server destination node
0 0 Server source node address.
address, 0 is broadcast.
1 Function code 0x17. 1 Function code 0x17.
Start register address to read Length of register data in read
2 2
MSB. (bytes).
Start register address to read
3 3 Register data 0 MSB.
LSB.
Number of 16 bit registers to
4 4 Register data 0 LSB.
Getting
read MSB.
started
Number of 16 bit registers to
5 5 Register data 1 MSB.
read LSB.
Start register address to write
6 6 Register data 1 LSB.
Protocols
MSB.
Start register address to write
7
LSB.
Number of 16 bit registers to
basics
write MSB.
Number of 16 bit registers to
9
write LSB.
Length of register data to write
10
pages
(bytes).
11 Register data 0 MSB.
12 Register data 0 LSB.
Applications
13 Register data 1 MSB.
14 Register data 1 LSB.
NOTE For each byte in the PDU message, the MSB is transmitted first, followed by the LSB.
Security
NOTE For both the request and response message, the register data is transmitted in ascend-
ing order, beginning with the start register address.
Diagnostics
NOTE The Modbus CRC bytes are not required when using TCP/IP due to the ethernet frame
providing the error checking. Advanced
features
reference
Quick
Glossary of
terms
Index
Safety
13.1 Complete parameter reference
Introduction
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
Mechanical Electrical
installation installation
Parameter Default Cross reference Description
Section 11.3.1 on
Pr MM.01 410 Module ID code.
page 92
Section 11.3.2 on
Pr MM.02 - Option software version.
page 92
Section 11.3.3 on
Pr MM.03 0 User allocated address.
page 93
Getting
started
Section 11.4.1 on
Pr MM.04 0 Ethernet data rate.
page 93
Section 11.4.2 on
Pr MM.05 0 DHCP enable.
page 93
Protocols
Section 11.5.1 on
Pr MM.06 0 Ethernet module diagnostic information.
page 99
Pr MM.10 192 IP address Wip.
pages
Pr MM.14 255 Subnet mask Wsubnet.
Pr MM.15 255 Section 5.12 on Subnet mask Xsubnet.
Applications
Pr MM.16 255 page 25 Subnet mask Ysubnet.
Pr MM.17 0 Subnet mask Zsubnet
Pr MM.18 192 Default gateway Wgateway.
Security
Pr MM.19 168
Pr MM.20 1 page 26 Default gateway Ygateway.
Pr MM.21 254 Default gateway Zgateway.
Diagnostics
Section 12.4.1 on
Pr MM.29 0 Module management.
page 106
Section 12.4.2 on
Pr MM.30 OFF Load option defaults.
page 106
Advanced
features
Section 12.4.3 on
Pr MM.31 OFF Save option parameters.
page 107
Section 12.4.4 on
Pr MM.32 OFF Request to re-initialise.
reference
page 107
Quick
Section 12.4.5 on
Pr MM.33 OFF Restore parameters.
page 108
Section 12.4.6 on
Glossary of
Section 12.4.7 on
Pr MM.36 OFF Disable full access.
page 108
Section 12.4.8 on
Pr MM.37 OFF Reduce SP serial interface priority.
Index
page 109
information
Safety
Parameter Default Description
Pr 60.36 OFF Disable full access.
Pr 60.37 OFF Reduce SP serial interface priority.
Introduction
Pr 60.38 0 User allocated group.
Pr 60.39 0 Connection filtering.
Pr 60.42 0 Duplex mode.
Mechanical Electrical
installation installation
Pr 60.43 0 Crossover detection.
Pr 60.44 - Actual baud rate.
Pr 60.45 - Actual duplex mode.
Pr 60.49 0 Non-critical warning condition.
Pr 60.50 0 Solutions Module error status.
Pr 60.51 - Solutions Module software sub-version.
Menu 61
Getting
started
Pr 61.00 0 Parameter zero.
Pr 61.01 - MAC address UMAC.
MAC address VMAC.
Protocols
Pr 61.02 -
Pr 61.03 - MAC address WMAC.
Pr 61.04 - MAC address XMAC.
basics
Pr 61.06 - MAC address ZMAC.
Pr 61.07 - Slot indicator.
Pr 61.10 4 (High) Modbus thread priority.
pages
Pr 61.11 3 (Medium) FTP thread priority.
Pr 61.12 3 (Medium) SMTP thread priority.
Applications
Pr 61.13 3 (Medium) HTTP thread priority.
Pr 61.14 4 (High) Event thread priority.
Pr 61.15 4 (High) EtherNet/IP thread priority.
Pr 61.20 5000 Modbus thread tick time (µs).
Security
Pr 61.21 2000 EtherNet/IP thread tick time (µs).
Pr 61.30 2000 Discovery and identification process silent period (ms).
Pr 61.31 30000 Discovery and identification process maximum search time (ms).
Diagnostics
Pr 61.32 30000 Discovery and identification process search retention time (ms).
Pr 61.33 250 IP communications timeout (ms).
Pr 61.34 500 IP routing timeout (ms).
Advanced
features
information
Safety
Parameter Default Description
Pr 64.10 - Connection status
Pr 64.11 ON RPI timeout trip enable.
Introduction
Pr 64.12 OFF Advanced EDS file enable.
Pr 64.13 7 Motor 1 type.
Pr 64.14 7 Motor 2 type.
Mechanical Electrical
installation installation
Pr 64.15 8 Primary input assembly object size (bytes).
Pr 64.16 8 Primary output assembly object size (bytes).
Pr 64.20 0 Input mapping parameter 1.
Pr 64.21 0 Input mapping parameter 2.
Pr 64.22 0 Input mapping parameter 3.
Pr 64.23 0 Input mapping parameter 4.
Pr 64.24 0 Input mapping parameter 5.
Getting
started
Pr 64.25 0 Input mapping parameter 6.
Pr 64.26 0 Input mapping parameter 7.
Pr 64.27 0 Input mapping parameter 8.
Protocols
Pr 64.28 0 Input mapping parameter 9.
Pr 64.29 0 Input mapping parameter 10.
Pr 64.30 0 Input mapping parameter 11.
pages
Pr 64.34 0 Input mapping parameter 15.
Pr 64.35 0 Input mapping parameter 16.
Pr 64.36 0 Input mapping parameter 17.
Applications
Pr 64.37 0 Input mapping parameter 18.
Pr 64.38 0 Input mapping parameter 19.
Pr 64.39 0 Input mapping parameter 20.
Pr 64.40 0 Input mapping parameter 21.
Security
Pr 64.41 0 Input mapping parameter 22.
Pr 64.42 0 Input mapping parameter 23.
Diagnostics
Pr 64.43 0 Input mapping parameter 24.
Pr 64.44 0 Input mapping parameter 25.
Pr 64.45 0 Input mapping parameter 26.
Pr 64.46 0 Input mapping parameter 27.
Advanced
features
NOTE The parameters in Table 13.2 are configured internally by the web pages and should not
be altered via parameter access directly.
Safety
Address: This is the unique network identification given to a networked device to allow
Introduction
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.
Mechanical Electrical
installation installation
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.
Getting
started
Auto-crossover detection: A method used to automatically detect if a crossover or
non-crossover network cable is connected.
Protocols
ADU: Application Data Unit. The complete Modbus message frame (ADU) consists of
the Modbus Application Protocol (MBAP) and Protocol Data Unit (PDU).
basics
Byte: A collection of 8 binary digits that collectively store a value. This may be signed or
unsigned.
pages
Class: A collection of properties which allow the control or monitoring of a device. Used
in conjunction with the Instance and Attribute properties.
Applications
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.
Security
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 Diagnostics
cable are connected straight through to the other end with the exception of the data pair
Advanced
which are transposed. Normally used to connect two network devices together as a
features
separate network.
Cyclic (implicit or polled) data: Data that is transmitted at regular intervals over the
reference
Data rate: Determines the communication speed of the network, the higher the value
Glossary of
the more data can be sent across the network in the same time period.
terms
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.
IP: Internet Protocol, this is the protocol used to transmit bytes across an IP network.
information
Safety
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
Introduction
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.
Mechanical Electrical
installation installation
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.
Node: A device on the network. This may be either a device such as a drive or part of
Getting
the network such as a repeater.
started
Non-crossover lead: See Patch lead.
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”.
basics
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
pages
connect a network device to a network switch.
Applications
PDU: Protocol Data Unit. This is the main Modbus message telegram, to which is added
the MBAP header to form the complete Modbus telegram.
Security
PLC: Programming Logic Controller.
Poll rate: The rate at which cyclic data is sent and received on the network.
RPI: Requested Packet Interval. Specifies the expected time for the device to respond
features
to a request.
Router: A device that is used to connect different networks or subnets, in a similar way
reference
Quick
to a firewall, however a router generally allows significantly less control of the data.
SMTP: Simple Mail Transfer Protocol. A protocol used for sending email.
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.
TCP: Transmission Control Protocol, this protocol is responsible for ensuring that the
data on the network reaches it’s 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.
Safety
Introduction
A
AC/DC Drive object ....................................................................................62
Account management ................................................................................88
Actual baud rate .........................................................................................97
Mechanical Electrical
installation installation
Actual duplex mode ....................................................................................97
Adding new accounts .................................................................................88
Addressing .................................................................................................19
Addressing etiquette ...................................................................................20
Administration accounts .............................................................................88
Advanced EDS File ....................................................................................33
Advanced parameter editor ........................................................................72
Getting
started
Alternative notation .....................................................................................21
Applications ................................................................................................79
Assembly object .................................................................................37, 123
Protocols
Attribute ....................................................................................................123
B
Backup .....................................................................................................107
basics
Basic speed and torque feedback ..............................................................45
Basic speed control ....................................................................................38
Basic speed feedback ................................................................................43
pages
Baud rate ....................................................................................................27
C
Applications
Cable shield connections ...........................................................................15
Cabling .......................................................................................................15
Cabling considerations ...............................................................................15
Cautions .......................................................................................................7
Security
Class A addresses .....................................................................................21
Class B addresses .....................................................................................21
Class C addresses .....................................................................................21
Diagnostics
Class D & E addresses ..............................................................................21
Class Types ................................................................................................20
Client request ...........................................................................113, 114, 115
Complete parameter reference ................................................................117
Advanced
features
Conformance ..............................................................................................12
Connecting .................................................................................................68
Connecting a PC ........................................................................................17
Glossary of
information
Safety
G
Generating your own pages .......................................................................77
Getting started ............................................................................................19
Introduction
Glossary of terms .....................................................................................123
Grounding ...................................................................................................15
H
Mechanical Electrical
installation installation
Help ............................................................................................................74
Home page ...........................................................................................70, 72
HTTP ..........................................................................................................31
Hubs ...........................................................................................................16
I
ID code .......................................................................................................92
Installing CTSoft .........................................................................................79
Getting
started
Installing SyPTPro ......................................................................................82
Instance ....................................................................................................124
Introduction .................................................................................................10
Protocols
IP address ......................................................................................21, 24, 93
J
JAVA scripts ...............................................................................................77
pages
Layout .........................................................................................................14
LED Diagnostics .........................................................................................90
Length of cable ...........................................................................................15
Applications
Load defaults ............................................................................................106
Logging in ...................................................................................................71
Low voltage supply .....................................................................................29
Security
M
MAC address ..............................................................................................98
Managing files ............................................................................................75
Diagnostics
Menu 20 .....................................................................................................29
Minimum software versions required for Ethernet ................................19, 79
Modbus exception codes ..........................................................................116
Modbus function codes ......................................................................30, 112
Advanced
features
Network ......................................................................................................74
terms
information
Subnet mask ........................................................................................21, 25
Safety
Supported drive assembly objects .............................................................38
Switch - using a single switch .....................................................................18
Introduction
Switch - using multiple switches .................................................................18
Switches .....................................................................................................16
SyPTLite ...............................................................................................84, 85
T
Mechanical Electrical
installation installation
TCP/IP Interface object ..............................................................................67
Top level menu ...........................................................................................70
U
Understanding custom pages .....................................................................77
Unlock code ................................................................................................71
Un-switched hubs .......................................................................................16
Getting
started
Updating SM-Ethernet firmware ...............................................................105
Updating SM-Ethernet language files .......................................................105
Uploading .................................................................................................105
Protocols
User accounts ............................................................................................88
User allocated address .......................................................................93, 110
User allocated group ................................................................................109
UU trip ........................................................................................................29
pages
Virus considerations ...................................................................................87
W
Applications
Warnings ......................................................................................................7
Web page ...................................................................................................31
Web page basics ........................................................................................68
Web page menu structure ..........................................................................69
Security
Where do IP addresses come from? ..........................................................19
Write consistency .......................................................................................34
X
Diagnostics
XML ............................................................................................................77
Advanced
features
reference
Quick
Glossary of
terms
Index