Professional Documents
Culture Documents
PLC Controlled Motion For Siemens - Speed RPM
PLC Controlled Motion For Siemens - Speed RPM
PLC Controlled
Motion for Siemens
- Speed RPM
Application software for Control Techniques drives and
Siemens PLCs
Issue: 3
Page 1 of 127
Page 2 of 127
1 INTRODUCTION ..................................................................................................................................... 5
1.1 TERMINOLOGY........................................................................................................................................ 7
1.2 AOI / FB NAMING CONVENTION ................................................................................................................ 7
1.3 PLC SPECIFICATION ............................................................................................................................... 7
2 SPEED RPM OVERVIEW ....................................................................................................................... 8
3 COMMISSIONING THE DRIVE ............................................................................................................. 10
3.1 BEST PRACTICE FOR INSTALLATION ........................................................................................................ 10
3.2 INSTALL CONNECT ................................................................................................................................ 10
3.3 CREATE A CONNECT PROJECT FOR THE APPLICATION .............................................................................. 10
3.4 ASSIGN AN IP ADDRESS ........................................................................................................................ 12
3.5 DEFAULT THE DRIVE AND CONFIGURE THE OPERATING MODE ................................................................... 15
3.6 VERIFY THE DRIVE FIRMWARE VERSION .................................................................................................. 15
3.7 USE THE PLC CONTROLLED MOTION SETUP TOOL TO CONFIGURE THE AXIS ............................................. 17
3.8 APPLY THE SETUP................................................................................................................................. 26
4 PLC SETUP ........................................................................................................................................... 27
4.1 OVERVIEW ........................................................................................................................................... 27
4.2 MINIMUM REQUIREMENTS ...................................................................................................................... 28
4.3 PREREQUISITE PLC SETUP ................................................................................................................... 28
4.4 IMPORT THE GLOBAL LIBRARY ARCHIVE ................................................................................................. 28
4.5 ADD A PLC AND A DRIVE AXIS TO THE PROJECT ...................................................................................... 30
4.6 COPY THE GLOBAL LIBRARY COMPONENTS TO THE PROJECT LIBRARY ...................................................... 36
4.7 CALL THE AXIS EXAMPLE FROM “MAIN” ................................................................................................... 39
4.8 COMPILE, DOWNLOAD AND VERIFY THE AXIS ........................................................................................... 40
4.9 MOVING AN AXIS FOR THE FIRST TIME ..................................................................................................... 43
4.10 DUPLICATING A FB EXAMPLE AXIS ..................................................................................................... 45
4.11 ADDING A DIFFERENT FB EXAMPLE AXIS ............................................................................................ 51
4.12 UPDATING PROJECT FUNCTION BLOCKS ............................................................................................. 59
4.13 UPDATING PROJECT GSD FILES ....................................................................................................... 59
4.14 MAPPING ADDITIONAL DATA .............................................................................................................. 62
5 CT_A_SPEEDRPM FB DESCRIPTION ................................................................................................ 65
5.1 FB DIAGRAM ........................................................................................................................................ 65
5.2 FB PROJECT DOCUMENTATION LANGUAGE ............................................................................................ 65
5.3 MOTION FB TARGETS ........................................................................................................................... 65
5.4 FB FUNCTIONALITY ............................................................................................................................... 66
5.4.1 General ........................................................................................................................... 66
5.4.2 Limit................................................................................................................................. 67
5.4.3 Common motion .............................................................................................................. 67
Page 3 of 127
Page 4 of 127
Ethernet
There are two sub categories of PLC Controlled Motion interfaces:
• AMC (Advanced Motion Controller) based
o Speed control in user defined units (closed speed and position loop)
▪ For M7xx and HS70
o Position control in user defined units (closed speed and position loop)
▪ For M7xx and HS70
o Electronic Gearbox in user defined units (closed speed and position loop)
▪ For M7xx HS70
• Non-AMC based
o Speed in rpm units (closed speed loop only)
▪ M600 to M7xx and HS70
o Frequency in Hz (open loop)
▪ For M200 to M7xx, C200, C300, HS30 and HS70
This functionality is implemented in the form of AOIs (Add-On Instructions) or FBs (Function Blocks)
that can be imported into the given PLC programming environment, and then controlled using cyclic
communications data to the target drive axis. See section 5 CT_A_SpeedRPM FB Description for
more information.
Page 5 of 127
(Example screen shot from the PLC Controlled Motion Connect Setup tool)
Page 6 of 127
Page 7 of 127
IN CT_A_SpeedRPM OUT
CyclicDataIn CyclicDataOut
CMD_DriveOn STS_CyclicCommsOK
CMD_DriveReset STS_DriveOn
CMD_MotionStop STS_DriveOK
CMD_JogForward STS_DriveEnabled
CMD_JogReverse STS_CurrentLimitActive
CMD_RunForward
STS_DriveAtZeroSpeed
CMD_RunReverse
CMD_HoldZeroSpeed STS_DriveAtSpeed
CMD_ManualBrakeForce STS_MotionStopActive
CFG_RPI_Time STS_JogActive
CFG_MaxSpeed STS_RunActive
CFG_InvertMotorDirection
STS_ReverseLimitSwitchOK
CFG_MotionStopDecelTime STS_ForwardLimitSwitchOK
CFG_MotionStopSrampPercent STS_SpeedFollowingErrorOK
CFG_JogSpeed STS_FB_ActiveError
CFG_JogAccelTime STS_DriveActiveAlarm
CFG_JogDecelTime STS_DriveLastTrip
CFG_JogSrampPercent STS_DriveLastSubTrip
CFG_RunSpeed STS_DrivePreRampedSpeed
CFG_RunAccelTime STS_DrivePostRampSpeed
CFG_RunDecelTime
STS_DriveActualSpeed
CFG_RunSrampPercent
STS_DriveLoadPercent
CFG_CurrentLimit STS_SpeedFollowingError
CFG_SpeedFollowingErrorLimit
CFG_BypassDebounceDelay
Page 8 of 127
Page 9 of 127
Page 10 of 127
4. Fill in the project name, then select “Empty Project” and click OK:
Page 11 of 127
3. The system will scan for any new drives connected to the PC, including any drives that have
not had an IP address configured yet e.g. a brand new drive does not have an IP address
configured “out of box”.
Where a drive does not have an IP address is will look similar to the screen shot below. Note
that the IP address is 0.0.0.0.
Page 12 of 127
Once all of the drives on the network have had their IP addresses assigned, click
to add any drives with a check mark, , to the project:
In the example above the drive with IP address 192.168.0.100 would be added to the project
when is clicked.
Page 13 of 127
The upload from drives dialog will start. By default, the drives parameters in the Connect
project will be updated for each drive. Click to complete the process.
Page 14 of 127
• When the “Default Parameters” pop-up appears configure the operating mode and frequency
if the ones suggested by Connect are not correct using the “Change…” option and then click
“Apply” to make the changes.
Page 15 of 127
3. The “Firmware Transfer” tool will open. Select the drive firmware, and then use the
“Browse…” button to locate the V01.19.00.00 drive firmware file.
Make sure that the drive is disabled and that any application software modules e.g. MCi210 or
SI-Applications Plus have their programs stopped.
Click to continue.
4. Click “Start Download” to begin the transfer of the firmware. Please ensure that the drive
remains powered up and the communications stay intact until the process has completed.
Page 16 of 127
Page 17 of 127
Videos showing step by step setup of an axis are available on the Control Techniques
YouTube® channel under PLC Controlled Motion.
Context based help is available when the mouse pointer is hovered over items in the PLC
Controlled Motion project to help with configration. If the help panel is not docked under the
project tree it can be invoked by clicking “View” > “Help”:
3. Note that for a complete configuration of the underlying parameters in the drive, the user must
view all of the tabs at least once, either by clicking the tabs to the left or by clicking “Next”.
Page 18 of 127
Page 19 of 127
Page 20 of 127
Slot 1
Menu 15
Slot 2
Menu 16
Slot 3
Menu 17
Page 21 of 127
o “RFC Feedback Mode” = “Feedback” is the most common configuration where the
motor speed has a speed feedback encoder which is used to close the speed loop.
o “RFC Feedback Mode” = “Sensorless” is the mainly used to recover a machine if the
main feedback encoder is broken. Sensorless mode uses current feedback data to
derive motor speed and thereby close the speed loop.
The thermistor settings allow the user to configure different types of motor thermistor that
could be connected to the drive feedback interface. The default setup is suitable for most
motors.
Note that for the Control Techniques demo cases for Unidrive M700 and Digitax HD M750, or
where the single motor cable solution is used, the thermistor type must be set to “Encoder” to
get the thermistor data over the EnDat encoder communications.
The Advanced Encoder Settings allow the user to configure whether an absolute encoder is
fitted to the system such that homing is only required once to datum the system when
commissioning.
Page 22 of 127
9. Use the “Hard Limits” tab to configure the drives digital input selection used for hardware axis
limits.
Page 23 of 127
o Where a braking resistor is fitted to the drive to dump regenerative energy from the
motor and load, the user must setup the properties of the braking resistor.
o Where a mechanical brake is fitted to the application, the user must select the digital
output that has been connected to the brake circuitry. The user may select from the
available outputs via the “Select the digital output for the brake selection” drop down
menu.
o Note that it is possible for maintenance purposes to force the mechanical brake to
apply or release from the CMD_MechanicalBrakeForce FB input. The user must
configure whether to apply or release the brake when manually forcing via the
“Manual Brake Forcing selection” drop down menu.
Page 24 of 127
Note that for Open-loop applications running with voltage modes Fixed, Fixed Tapered and
Square the Auto-tune step is not required.
Page 25 of 127
2. At this point the drive has all of the data needed to tune the drive the connected motor. Before
performing the Autotune pleas ensure you have read the safety information in the drive user
guide. Autotuning may cause the motor shaft to rotate and deliver considerable torque into
any mechanism coupled to the motor. You should be sure before proceeding that you have
taken precautions to prevent injury or danger to life. You should satisfy yourself that if a load
is connected to the motor then the coupling and other mechanical arrangements are capable
of withstanding the full continuous and overload torque of the motor.
3. Note that when using open-loop voltage mode Fixed, Square and Fixed Tapered with a
default setup that an autotune is not required. The only exception is where catch a spinning
motor is enabled.
4. Where a PLC has been used to configure the drives PROFINET connection, disable
PROFINET comms by setting Prx.24.001 to “Off” e.g. for the multi-protocol factory fitted
Ethernet module set Pr4.24.001 to “Off”. For SI-PROFINET V2 disconnect the PLC from the
Ethernet network. The PROFINET comms may be reintroduced after the autotune has been
completed successfully.
5. Autotune the motor by clicking on the “Start Autotune” button. This takes the drive on-line and
starts the autotune wizard. Follow the on-screen instructions to complete the autotune, and
when completed, close the autotune tab.
6. Note that when the Autotune has completed the user must disable the drive via the STO input
at least once before motion will be permitted.
7. When the Autotune has been completed successfully the drive setup must be saved by
clicking on the “Save and start PLC comms” button. This button also reset the
communications to start the PLC communications.
8. Save copy of the drive parameters in the offline project. Click on the “Upload from drive”
button to keep a local copy of the final setup.
9. The next step is to set up the PLC. Note that the PLC code is available in the
C:\Users\Public\Public Documents\Control Techniques\PLC Controlled
Motion\Siemens\Global Library Archive by clicking the “Open PLC code and documentation
button.”
Page 26 of 127
4.1 Overview
From the TIA Portal and PLC perspective, all the software files required to get PLC Controlled Motion
working are provided in the following location:
• C:\Users\Public\Public Documents\Control Techniques\PLC Controlled
Motion\Siemens\Global Library Archive
o Once the Global Library Archive has been imported using “Options > Global Libraries
> Retrieve Library” following library structure will be seen:
o Axis Examples gives complete working code for each axis type i.e. Frequency Hz,
Speed RPM, Speed AMC, Position AMC and EGB AMC. All of the examples can be
freely modified.
o Motion System contains all of the underpinning Functions and function blocks that
make up PLC Controlled Motion.
▪ For Commander C200 and C300, Unidrive M200, M300, M400 and M600 use
“SI- PROFINET V2”.
▪ For Unidrive M70x, Digitax HD M75x use
“Multi Protocol Factory Fit Ethernet”.
Page 27 of 127
5. Choose the target location for the retrieved library, then click OK.
Page 28 of 127
Page 29 of 127
2. Select the application PLC using the Add new device window. Click “OK” when the correct
PLC has been selected.
3. Check that the PLC can be seen in the project. Click “Online access > Comms Interface >
Update accessible devices”. After 30s or so the application PLC will appear below the comms
adapter name indicating that TIA portal can see the PLC. If the PLC does not appear please
follow the Siemens instructions on how to configure the IP address of a PLC.
It can be seen in the example above that PLC IP adress 192.168.0.30 can be seen by TIA
portal.
Page 30 of 127
On the “General” tab select “PROFINET Interface” and then set the project PLC IP address to
the same one as the physical PLC.
5. Next the drive must be added to the network. To do this click the Library tab and navigate
“Siemens PLC Controlled Motion Library > Master copies > PLC Controlled Motion >
PROFINET Drive Modules”.
For Digitax HD M750 select the interfaces in the “Multi Protocol Factory Fit Ethernet” folder,
and for Commander C200 and C300, Unidrive M200 to M600 and Digitax HD M751 select the
interface in the “SI- PROFINET V2” folder. Unidrive M70x is may be used with either SI-
PROFIBUS V2 or Multi Protocol Factory Fit Ethernet.
Page 31 of 127
The table below indicates which drives, motion FBs, motion examples and PROFINET
interfaces work together:
Drive Motion FB Motion Example PROFINET Interface
Commander CT_A_FrequencyHz Frequency Hz M200 To M400 Axis A1_FrequencyHz_SI_M200_
C200 C300 Example To_M400
Unidrive CT_A_FrequencyHz Frequency Hz C200 C300 Axis
A1_FrequencyHz_SI_C200_
M20x M30x Example
C300
M40x
CT_A_SpeedAMC Speed AMC M750 Axis Example
CT_A_PositionAMC Position AMC M750 Axis Example
A1_AMC_Motion_M750
Digitax HD CT_A_ElectronicGearBox_ EGB AMC M750 Axis Example
M750 AMC
CT_A_SpeedRPM Speed RPM M750 Axis Example A1_SpeedRPM_ M750
CT_A_FrequencyHz Frequency Hz M750 Axis Example A1_FrequencyHz_M750
CT_A_SpeedRPM Speed RPM SI M751 Axis
A1_SpeedRPM_SI_M751
Example
CT_A_FrequencyHz Frequency Hz SI M751 Axis
A1_FrequencyHz_SI_M751
Digitax HD Example
M751 CT_A_SpeedAMC Speed AMC SI M751 Axis
Example
A1_AMC_Motion_SI_M751
CT_A_PositionAMC Position AMC SI M751 Axis
Example
Page 32 of 127
Note that the drive axis PROFINET interface interface has changed from Not assigned to
PLC_1 indicating the link has been made.
8. Next the IP address for the target drive must be configured to match the one that was
configured using the PLC Controlled Motion setup tool. Double click on the dark grey box
within the PROFINET interface.
Select the “General” tab and then “PROFINET Interface” and then configure the project IP
address as assigned using the PLC Controlled Motion setup tool.
Page 33 of 127
Click to make sure the PLC has its name and IP address assigned. It will
look similar to the example below if it is OK.
Click to to show the list of available target drive axes. Click on the drive
axis that is going to be a part of the system.
Page 34 of 127
Page 35 of 127
Page 36 of 127
When complete, the “System” folder will be visible in the PLC properties under “Program
blocks”.
Page 37 of 127
When complete the axis example folder will be visible in the PLC properties under “Program
blocks”.
Page 38 of 127
2. Open the “Position AMC Axis Example” folder under “Devices > PLC > Program blocks”, and
the drag the “PositionAMC_M70x_A1” function block and drop it onto the top rung of the
“Main” OB.
The “Call options” dialog will appear. Change the data block assigned to the one in the
example folder. For the position example the data block is called “PositionAMC_A1_DB”.
Click “OK” when the example data base has been selected. The completed code change will
be similar to the example below:
Page 39 of 127
3. Download the project to the drive using the “Download to device” button .
The “Extended download to device” dialog will appear if this is the first time the PLC has been
programmed. Configure the connection settings. An example is given below.
When this has been completed click to find the physical PLC on the Ethernet
network, and add it to the “Select target device” list. When the search completes select the
application PLC from the “Select target device” list and then click “Load”
Page 40 of 127
4. Check if the cyclic communications are working after the download. Check “Project tree >
Devices > PLC” where “Local modules” and “Distributed I/O” must have a to the right.
Page 41 of 127
area, and then scroll down to Network 2, and then click to monitor the code on-line.
Page 42 of 127
Note that to access CMD_DriveOn, unlike the Rockwell RSLogix environment, values can’t be
changed directly from the Ladder logic view. Access can be made by directly accessing the
data block e.g. PositionAMC_M70x_A1_DB, or by creating a watch table. A watch table can
be created by navigating to “Project Tree > Devices > PLC > Watch and force tables > Add
new watch table”.
Page 43 of 127
Page 44 of 127
3. Connect the new comms interface to the PLC by clicking and dragging the green square on
the PLC to the green square on the new axis PROFINET interface.
Page 45 of 127
5. Push the name and IP Address to the new axis. Right click on the rectangular box in the
middle of the network connection line, and select “Assign device name”
When the “Assign PROFINET device name” dialog appears, set “Configured PROFINET
device > PROFINET device name” to the name given to the new axis e.g. a2_amc_motion.
Page 46 of 127
When the name and IP address are assigned the entry in the “Accessible devices in the
network table” will change as shown below.
6. Copy and paste the axis function blocks by clicking on “Project tree > Devices > PLC >
Program blocks > Position AMC Axis Example” and copy the folder, then paste when “Project
tree > Devices > PLC > Program blocks” is selected so that the new axis sits at the same
level as the existing one.
Rename the folders and sub items to match the PROFINET interface name.
Page 47 of 127
Repeat this process for the “WriteOutputData xxx” function block e.g.
WriteOutputDataPositionAMC_M70x_A2. When this has been completed the communications
and motion function block are now linked.
Page 48 of 127
Open the “Position AMC Axis 2 Example” folder under “Devices > PLC > Program blocks”,
and the drag the “PositionAMC_A2” function block and drop it onto the top rung of the “Main”
OB next to the original axis function block.
The “Call options” dialog will appear. Change the data block assigned to the one in the
example folder. For the position example the data block is called “PositionAMC_A2_DB”.
Click “OK” when the example data base has been selected. The completed code change will
be similar to the example below:
Page 49 of 127
Page 50 of 127
For Digitax HD M750 select the interfaces in the “Multi Protocol Factory Fit Ethernet” folder,
and for Commander C200 and C300, Unidrive M200 to M600 and Digitax HD M751 select the
interface in the “SI- PROFINET V2” folder. Unidrive M70x is may be used with either SI-
PROFIBUS V2 or Multi Protocol Factory Fit Ethernet.
The following example is for an M700 that will run the Electronic Gear Box function block
which is a part of the AMC family of motion interfaces so the A1_AMC_Motion interface must
be dragged and dropped into the “Network view” next to the PLC. Note that A1 is short form
for Axis1.
Page 51 of 127
Page 52 of 127
3. Connect the new comms interface to the PLC by clicking and dragging the green square on
the PLC to the green square on the new axis PROFINET interface.
Page 53 of 127
5. Push the name and IP Address to the new axis. Right click on the rectangular box in the
middle of the network connection line, and select “Assign device name”
When the “Assign PROFINET device name” dialog appears, set “Configured PROFINET
device > PROFINET device name” to the name given to the new axis e.g.
a2_amc_motion_m70x.
Page 54 of 127
When the name and IP address are assigned the entry in the “Accessible devices in the
network table” will change as shown below.
Page 55 of 127
Click and drag the axis example for the application from the global library to the PLCs
“Program blocks” folder. The target axis will use the “EGB AMC M70x Axis Example”.
Page 56 of 127
Rename the axis to match the comms interface name e.g. EGB AMC Axis 2 Example.
Repeat this process for the “WriteOutputData xxx” function block e.g.
WriteOutputData_EGB_AMC_M70x_A2. When this has been completed the communications
and motion function block are now linked.
Page 57 of 127
Open the “EGB AMC M70x Axis 2 Example” folder under “Devices > PLC > Program blocks”,
and the drag the “EGB_AMC_M70x_A2” function block and drop it onto the top rung of the
“Main” OB next to the original axis function block.
The “Call options” dialog will appear. Change the data block assigned to the one in the
example folder. For the position example the data block is called
“PositionAMC_M70x_A2_DB”.
Click “OK” when the example data base has been selected. The completed code change will
be similar to the example below:
Page 58 of 127
3. When the “Manage general station description files” dialog appears tick the GSD file that is
“Not yet installed”. Click “Install” to install the GSD to TIA portal.
Page 59 of 127
6. On the “General” tab for the PROFINET interface, and scroll down to “Catalog information”
and click “Change revision”.
Page 60 of 127
8. The new GSD file will be referenced in the “Catalog information” for all I/O devices using the
original GSD file.
Page 61 of 127
2. When the “Devices & networks” tab opens, double click on the drive and motor icon.
3. When the “Device overview“ tab opens, scroll down past the PLC Controlled Motion
parameter mappings to an empty cell.
Page 62 of 127
5. Make a note of the start memory location where the data will be placed, in this example 23:
Page 63 of 127
In the example below the address is %ID23 where %I represents inputs registers, D
represents data type DINT, and 23 is the starting byte for the input PROFINET register.
Page 64 of 127
IN CT_A_SpeedRPM OUT
CyclicDataIn CyclicDataOut
CMD_DriveOn STS_CyclicCommsOK
CMD_DriveReset STS_DriveOn
CMD_MotionStop STS_DriveOK
CMD_JogForward STS_DriveEnabled
CMD_JogReverse STS_CurrentLimitActive
CMD_RunForward
STS_DriveAtZeroSpeed
CMD_RunReverse
CMD_HoldZeroSpeed STS_DriveAtSpeed
CMD_ManualBrakeForce STS_MotionStopActive
CFG_RPI_Time STS_JogActive
CFG_MaxSpeed STS_RunActive
CFG_InvertMotorDirection
STS_ReverseLimitSwitchOK
CFG_MotionStopDecelTime STS_ForwardLimitSwitchOK
CFG_MotionStopSrampPercent STS_SpeedFollowingErrorOK
CFG_JogSpeed STS_FB_ActiveError
CFG_JogAccelTime STS_DriveActiveAlarm
CFG_JogDecelTime STS_DriveLastTrip
CFG_JogSrampPercent STS_DriveLastSubTrip
CFG_RunSpeed STS_DrivePreRampedSpeed
CFG_RunAccelTime STS_DrivePostRampSpeed
CFG_RunDecelTime
STS_DriveActualSpeed
CFG_RunSrampPercent
STS_DriveLoadPercent
CFG_CurrentLimit STS_SpeedFollowingError
CFG_SpeedFollowingErrorLimit
CFG_BypassDebounceDelay
Page 65 of 127
5.4.1 General
CMD_DriveOn STS_CyclicCommsOK
CMD_DriveReset STS_DriveOn
CMD_ManualBrakeForce STS_DriveOK
CFG_InvertMotorDirection STS_DriveEnabled
CMD_HoldZeroSpeed STS_FB_ActiveError
STS_DriveActiveAlarm
STS_DriveLastTrip
STS_DriveLastSubTrip
STS_DriveLoadPercent
Page 66 of 127
The intention is that the user connect the Boolean STS_SpeedFollowingErrorLimitOK output
to some PLC logic that will handle the limit breach in a way that is sympathetic to the machine
design e.g. bring the axis to a stop.
Page 67 of 127
Motion stop gives the user the ability to ramp the motion profile to a stop. This reference has
individual deceleration time and S-ramp percentage so the deceleration may be customised to the
machine requirement.
Motion Stop is intended to be used to rapidly stop the axis where the user would normally set the jerk
percentage to 0, (giving linear speed ramps), and a small deceleration time.
When CMD_MotionStop is activated it has priority over all other motion references e.g. if the system
is jogging using CMD_JogForward and later motion stop is activated by setting CMD_MotionStop to 1
then the motion stop profile will be activated bringing the profile stop overriding the jog command.
CFG_MotionStopSrmapPercent
Axis Speed
CFG_MotionStopDecelTime
CMD_MotionStop
STS_MotionStopActive
Motion CMD
Motion Active STS
Page 68 of 127
The jog function gives the user a standard interface to implement a standard manual jogging control.
The jogging reference has independent control inputs for jogging forward and jogging in reverse that
may be routed to a manual user control.
The jogging reference has its own motion profile where the jogging speed, accel/decel time and
S-ramp percentage can be configured.
Note that the maximum speed that may be configured is defined by CFG_MaxSpeed.
Status information is available to allow the used to detect when the jog reference is active, indicated
by STS_JogActive.
CFG_JogSpeed
CFG_JogSrmapPercent
CFG_JogDecelTime
CFG_JogAccelTime
CMD_JogForward
STS_JogActive
CMD_JogReverse
Page 69 of 127
The run reference allows the user to make the target axis move at a user defined speed target
configured using CFG_RunSpeed. The run speed target has its own motion profile e.g. accel / decel
time and S-ramp percentage.
Note that the maximum speed that may be configured is defined by CFG_MaxSpeed.
This reference is intended to be used by an automated process to control the speed of the axis, rather
than the Jog function which is intended to be used by a manual control scheme.
Status information is available to allow the used to detect when the speed reference is active,
indicated by STS_RunActive.
CFG_RunFreq
CFG_RunSrmapPercent
CFG_RunDecelTime
CFG_RunAccelTime
CMD_RunForward
STS_RunActive
CMD_RunReverse
Page 70 of 127
FB Parameter CyclicDataIn
Description The function block interface to the PROFINET cyclic input mapping data. Each
DINT element in the array represents a value received from the target drive by
the PLC.
This must be linked to the #CyclicDataIn tag connected to the instance of the
ReadInputData xxx function block for the axis.
FB Parameter CyclicDataOut
Description The function block interface to the PROFINET cyclic output mapping data. Each
DINT element in the array represents a value sent by the PLC to the drive.
This must be linked to the #CyclicDataOut tag connected to the instance of the
WriteOutputData xxx function block for the axis.
Page 71 of 127
FB Parameter CMD_DriveOn
Description When set to 0, the drive will become inhibited by removing the software
enable, the run signal will be removed.
When set to 1, the drive will be software enabled. Provided the hardware
enable is applied to the drive by applying 24V to the STO input(s), and a
motion command is provided, (CMD_JogForwards, CMD_JogReverse,
CMD_RunForward or CMD_RunReverse), the drive will transition to the run
and will begin to apply the selected motion reference profile.
CMD_DriveOn will be inhibited if STS_FB_ActiveError = 6, This is a drive
mode mismatch.
In the event that CMD_MotionStop = 1 at the same time as CMD_DriveOn
changes from 1 to 0 (motion was in progress), CMD_MotionStop has
priority and will bring the axis to a controlled stop before disabling the target
drive.
Note that to provide holding torque at the shaft when only CMD_DriveOn =1
CMD_HoldZeroSpeed must be set to 1. Sufficient motor cooling must be
provided when using the CMD_HoldZeroSpeed feature.
Usage Input Data Type BOOL
Unit N/A Drive Parameter Pr6.042 Bit0 and 5
Minimum 0 Maximum 1
Visible Yes Required Yes
FB Parameter CMD_DriveReset
Description On a rising edge transition, from 0 to 1, the drive will be reset. This is the
equivalent of pressing the red reset button on the keypad of the target drive
axis. Internally the reset will be actioned for 150ms to allow the command to
propagate to the target drive axis via PROFINET cyclic communications.
Usage Input Data Type BOOL
Unit N/A Drive Parameter Pr6.042 Bit13
Minimum 0 Maximum 1
Visible Yes Required No
Page 72 of 127
Description When set to 1, all other motion references will be superseded by motion
stop regardless of the state of their CMD bit. The target drive axis will be
stopped using the profile defined by CFG_MotionStopDecelTime and
CFG_MotionStopSrampPercent.
Once motion stop has been requested, the target drive axis will be
commanded to reach zero speed even if CMD_MotionStop is set to 0. Once
the target drive axis has stopped i.e. STS_DriveAtZeroSpeed = 1, new
motion can only be started provided CMD_MotionStop = 0 and the other
motion reference are not selected for at least one PLC task scan i.e.
CMD_JogForward = 0, CMD_JogReverse = 0, CMD_RunForward = 0 and
CMD_RunReverse = 0 for a minimum of one PLC task scan. This prevents
the target drive axis from inadvertently moving following completion of a
motion stop.
In the event that CMD_MotionStop = 1 at the same time as CMD_DriveOn
changes from 1 to 0 (motion was in progress), CMD_MotionStop has
priority and will bring the axis to a controlled stop before disabling the target
drive.
Usage Input Data Type BOOL
Unit N/A Drive Parameter N/A
Minimum 0 Maximum 1
Visible Yes Required No
Page 73 of 127
Description When set to 1, the target drive axis will jog forwards using the profile
configuration defined by CFG_JogSpeed, CFG_JogAccelTime,
CFG_JogDecelTime and CFG_JogSrampPercent.
CMD_JogForward and CMD_JogReverse are XORed with each other
where:
• CMD_JogForward = 0 and CMD_JogReverse = 0 → No selection
• CMD_JogForward = 1 and CMD_JogReverse = 1 → No selection
• CMD_JogForward = 1 and CMD_JogReverse = 0 → Jog Forward
• CMD_JogForward = 0 and CMD_JogReverse = 1 → Jog Reverse
When the axis has been jogging and CMD_JogForward and
CMD_JogReverse = 0, then the axis will decelerate to a stop using the
profile defined by CFG_JogDecelTime and CFG_JogSrampPercent.
This motion reference is superseded by CMD_MotionStop.
This motion reference can only be activated when CMD_DriveOn = 1 and
when no other motion reference is selected.
Usage Input Data Type BOOL
Unit N/A Drive Parameter N/A
Minimum 0 Maximum 1
Visible Yes Required No
Page 74 of 127
Description When set to 1, the target drive axis will jog in reverse using the profile
configuration defined by CFG_JogSpeed, CFG_JogAccelTime,
CFG_JogDecelTime and CFG_JogSrampPercent.
CMD_JogForward and CMD_JogReverse are XORed with each other
where:
• CMD_JogForward = 0 and CMD_JogReverse = 0 → No selection
• CMD_JogForward = 1 and CMD_JogReverse = 1 → No selection
• CMD_JogForward = 1 and CMD_JogReverse = 0 → Jog Forward
• CMD_JogForward = 0 and CMD_JogReverse = 1 → Jog Reverse
When the axis has been jogging and CMD_JogForward and
CMD_JogReverse = 0, then the axis will decelerate to a stop using the
profile defined by CFG_JogDecelTime and CFG_JogSrampPercent.
This motion reference is superseded by CMD_MotionStop.
This motion reference can only be activated when CMD_DriveOn = 1 and
when no other motion reference is selected.
Usage Input Data Type BOOL
Unit N/A Drive Parameter N/A
Minimum 0 Maximum 1
Visible Yes Required No
Page 75 of 127
Description When set to 1, the target drive axis will run forwards using the profile
configuration defined by CFG_RunSpeed, CFG_RunAccelTime,
CFG_RunDecelTime and CFG_RunSRampPercent.
CMD_RunForward and CMD_RunReverse are XORed with each other
where:
• CMD_RunForward = 0 and CMD_RunReverse = 0 → No selection
• CMD_RunForward = 1 and CMD_RunReverse = 1 → No selection
• CMD_RunForward = 1 and CMD_RunReverse = 0 → Jog Forward
• CMD_RunForward = 0 and CMD_RunReverse = 1 → Jog Reverse
When the axis has been running and CMD_RunForward and
CMD_RunReverse = 0, then the axis will decelerate to a stop using the
profile defined by CFG_RunDecelTime and CFG_RunSRampPercent.
This motion reference is superseded by CMD_MotionStop.
This motion reference can only be activated when CMD_DriveOn = 1 and
when no other motion reference is selected.
Usage Input Data Type BOOL
Unit N/A Drive Parameter N/A
Minimum 0 Maximum 1
Visible Yes Required No
Page 76 of 127
Description When set to 1, the target drive axis will run in reverse using the profile
configuration defined by CFG_RunSpeed, CFG_JogAccelTime,
CFG_JogDecelTime and CFG_RunSRampPercent.
CMD_RunForward and CMD_RunReverse are XORed with each other
where:
• CMD_RunForward = 0 and CMD_RunReverse = 0 → No selection
• CMD_RunForward = 1 and CMD_RunReverse = 1 → No selection
• CMD_RunForward = 1 and CMD_RunReverse = 0 → Jog Forward
• CMD_RunForward = 0 and CMD_RunReverse = 1 → Jog Reverse
When the axis has been running and CMD_RunForward and
CMD_RunReverse = 0, then the axis will decelerate to a stop using the
profile defined by CFG_RunDecelTime and CFG_RunSRampPercent.
This motion reference is superseded by CMD_MotionStop.
This motion reference can only be activated when CMD_DriveOn = 1 and
when no other motion reference is selected.
Usage Input Data Type BOOL
Unit N/A Drive Parameter N/A
Minimum 0 Maximum 1
Visible Yes Required No
FB Parameter CMD_HoldZeroSpeed
Description When set to 1, the target drive axis will remain active in the “Stop” state with
a speed reference of zero provided the drive remains enabled and no
motion CMD bits are selected, thereby apply holding torque at the motor
shaft.
When set to 0, the target drive axis will go to the “Ready” state provided the
drive remains enabled and no motion CMD bits are selected.
STS_DriveOn = 1 when CMD_HoldZeroSpeed = 1 and CMD_DriveOn = 1
provided the drive remains enabled and no motion CMD bits are selected,
indicating that the drive is active.
Note that this must be set to 1 for the correct operation of the drive brake
controller if mechanical brake control is used.
Sufficient motor cooling must be provided when using this feature.
Usage Input Data Type BOOL
Unit N/A Drive Parameter 6.008
Minimum 0 Maximum 1
Visible Yes Required No
Page 77 of 127
Description When set to 0, the mechanical brake controller in the target axis drive is in
charge of the operation of the brake control output.
When set to 1, the mechanical brake controller in the target axis drive is
bypassed and the output is forced to apply or release brake control output
as requested. The PLC Controlled Motion Connect setup tool sets whether
the brake is applied or released when forced.
Note that the manual brake force feature completely overrides the brake
controller such that even if the drive is tripped the brake will remain forced
to the user selected state (applied or released).
Usage Input Data Type BOOL
Unit N/A Drive Parameter Pr12.010
Minimum 0 Maximum 1
Visible Yes Required No
FB Parameter CFG_RPI_Time
Description CFG_RPI_Time allows the user to optimise the reference timing from the
PLC to the target axis. CFG_RPI_Time must be set to the Ethernet cyclic
link update time in millisecond units. The PLC cyclic communication time
must not be set greater than 100ms. The default of 100ms will work in all
cases but offers the least optimised reference timing to the target axis.
Usage Input Data Type DINT
Unit ms Drive Parameter N/A
Minimum 1 Maximum 100
Visible Yes Required No
FB Parameter CFG_InvertMotorDirection
Page 78 of 127
Description Defines the maximum Speed reference that the target drive axis will accept.
The FB will internally limit all frequency demands to this maximum.
CFG_MaxSpeed forms the basis of the acceleration units which are
s/CFG_MaxSpeed e.g. if an acceleration rate = 1.0s and CFG_MaxSpeed =
50.0 rpm then the acceleration rate will be 1.0s/50.0 rpm or 50rpm per 1.0
second.
Fixed precision of 1 decimal place.
The working maximum is given by 550 * 60 / motor pole pairs, where the
maximum frequency that can be applied to the motor is 550Hz.
Values will be internally limited to a range of 0.0 to 50000.0.
Usage Input Data Type REAL
Unit Rpm Drive Parameter Pr1.006
Minimum 0.0 Maximum 50000.0
Visible Yes Required No
FB Parameter CFG_MotionStopDecelTime
Page 79 of 127
Description Defines the jerk rate in percentage of S Ramp units used when
CMD_MotionStop = 1. Fixed precision of 1 decimal place. When set to 0,
linear speed ramps will be used.
The S Ramp is implemented in a way that preserves the defined
acceleration / deceleration time but increases the maximum acceleration /
deceleration and therefore the torque in doing so.
Fixed precision of 1 decimal place.
Values will be internally limited to a range of 0.0% to 100.0%.
Usage Input Data Type REAL
Unit S Ramp % Drive Parameter Pr2.040
Minimum 0.0 Maximum 100.0
Visible Yes Required No
FB Parameter CFG_JogSpeed
Description Defines the maximum speed in rpm units used when CMD_JogForward or
CMD_JogReverse = 1. Fixed precision of 1 decimal place.
Values < 0 will be internally limited to 0.
Usage Input Data Type REAL
Unit Rpm Drive Parameter Pr1.021
Minimum 0.0 Maximum CFG_MaxSpeed
Visible Yes Required No
FB Parameter CFG_JogAccelTime
Page 80 of 127
FB Parameter CFG_JogSrampPercent
Description Defines the jerk rate in percentage of S Ramp units used when
CMD_JogForward or CMD_JogReverse = 1. Fixed precision of 1 decimal
place. When set to 0, linear speed ramps will be used.
The S Ramp is implemented in a way that preserves the defined
acceleration / deceleration time but increases the maximum acceleration /
deceleration and therefore the torque in doing so.
Fixed precision of 1 decimal place.
Values will be internally limited to a range of 0.0% to 100.0%.
Usage Input Data Type REAL
Unit S Ramp % Drive Parameter Pr2.040
Minimum 0.0 Maximum 100.0
Visible Yes Required No
FB Parameter CFG_RunSpeed
Page 81 of 127
FB Parameter CFG_RunDecelTime
Page 82 of 127
Description Defines the jerk rate in percentage of S Ramp units used when
CMD_RunForward or CMD_RunReverse = 1. Fixed precision of 1 decimal
place. When set to 0, linear speed ramps will be used.
The S Ramp is implemented in a way that preserves the defined
acceleration / deceleration time but increases the maximum acceleration /
deceleration and therefore the torque in doing so.
Fixed precision of 1 decimal place.
Values will be internally limited to a range of 0.0% to 100.0%.
Usage Input Data Type REAL
Unit S Ramp % Drive Parameter Pr2.040
Minimum 0.0 Maximum 50.0
Visible Yes Required No
FB Parameter CFG_CurrentLimit
Description Defines the symmetrical current limit in percent of motor rated current units.
CFG_CurrentLimit value can be changed at any time.
Fixed precision of 1 decimal place.
Usage Input Data Type REAL
Unit % rated current Drive Parameter Pr4.007
Minimum 0.0 Maximum Rating dependant
Visible Yes Required No
FB Parameter CFG_SpeedFollowingErrorLimit
Description Defines the symmetrical speed following error limit used to detect when the
speed following error is within acceptable limits. This limit is then used to
derive STS_SpeedFollowingErrorLimitOK. It also defines the acceptable
following error for STS_DriveAtZeroSpeed and STS_DriveAtSpeed.
Changes to CFG_SpeedFollowingErrorLimit take effect immediately.
The working maximum is given by 550 * 60 / motor pole pairs, where the
maximum frequency that can be applied to the motor is 550Hz.
This is an FB internal calculation.
Usage Input Data Type REAL
Unit rpm Drive Parameter N/A
Minimum 0.0 Maximum 50000.0
Visible Yes Required No
Page 83 of 127
Description When set to 0, the profile is protected from speed overshoot. When set to 1,
the profile may be updated at any time, but there is a possibility of profile
overshoot, particularly when changing from short acceleration / deceleration
times and low jerk percentages, to long acceleration / deceleration times
and high jerk percentages while the axis speed is changing.
It is recommended to leave this set to 0 where possible, and only change to
1 when the overshoot protection must be bypassed. It is not recommended
to leave this input set to 1 permanently.
Usage Input Data Type BOOL
Unit N/A Drive Parameter N/A
Minimum 0 Maximum 1
Visible No Required No
Page 84 of 127
FB Parameter STS_CyclicCommsOK
Description When set to 0, indicates that the cyclic communications used to control the
target drive axis are not working.
When set to 1, indicates that the cyclic communications used to control the
target drive axis are working correctly.
Usage Output Data Type BOOL
Unit N/A Drive Parameter N/A
Minimum 0 Maximum 1
Visible Yes Required No
FB Parameter STS_DriveOn
Description When set to 0, indicates that the drive is not on i.e. not in the run state.
When set to 1, indicates that the drive is on and motion has been
commanded i.e. enabled, the drive is healthy, a motion CMD bit is applied,
and the final drive reports run or drive active and there are no trips.
Usage Output Data Type BOOL
Unit N/A Drive Parameter Pr10.001 & Pr10.002 &
not Pr10.005
Minimum 0 Maximum 1
Visible Yes Required No
FB Parameter STS_DriveOK
Description When set to 0, indicates that the drive is unhealthy i.e. tripped. The specific
trip may be read from STS_DriveLastTrip and STS_DriveLastSubTrip.
When set to 1, indicates that the drive is healthy i.e. not tripped.
Usage Output Data Type BOOL
Unit N/A Drive Parameter Pr10.040 Bit0
Minimum 0 Maximum 1
Visible Yes Required No
Page 85 of 127
Description When set to 0, indicates that the target drive axis safe toque off feature is
active i.e. 0V is applied to a target drive axis STO terminal.
When set to 1, indicates that the drive is hardware enabled i.e. 24V is
applied to the target drive axis STO terminal(s).
When CMD_DriveOn = 0, STS_DriveEnabled = 0.
Usage Output Data Type BOOL
Unit N/A Drive Parameter Pr8.071
Minimum 0 Maximum 1
Visible Yes Required No
FB Parameter STS_CurrentLimitActive
Description When set to 0, indicates that the current is less than the limit.
When set to 1, indicates that the current limit has been reached or exceed.
Usage Output Data Type BOOL
Unit N/A Drive Parameter Pr10.009
Minimum 0 Maximum 1
Visible Yes Required No
FB Parameter STS_DriveAtZeroSpeed
Description When set to 0, indicates that the target drive output speed is not 0 Speed.
When set to 1, indicates that the target drive output speed is at 0 Speed.
Usage Output Data Type BOOL
Unit N/A Drive Parameter Pr10.003
Minimum 0 Maximum 1
Visible Yes Required No
Page 86 of 127
Description When set to 0, indicates that the target drive output frequency is not at the
demand value.
When set to 1, indicates that the target drive output speed is at the demand
value i.e. STS_DrivePreRampSpeed = STS_DrivePostRampSpeed.
Usage Output Data Type BOOL
Unit N/A Drive Parameter Pr100.1, Pr5.001
Minimum 0 Maximum 1
Visible Yes Required No
FB Parameter STS_MotionStopActive
Description When set to 0, indicates that the motion stop reference is not active.
When set to 1, indicates that the motion stop reference is active where all
other motion references are superseded and the target drive axis will slow
down and stop.
This bit remains set while decelerating to a stop even if CMD_MotionStop is
reset to 0.
In the event that CMD_JogForwards, CMD_JogReverse,
CMD_RunForward or CMD_JogReverse = 1 during a motion stop and
remain 1 after CMD_MotionStop = 0 then this bit will remain 1 to indicate
that motion stop is still activated to prevent an unexpected movement after
0 speed is reached. To begin new movement after a motion stop all motion
reference CMD bits must = 0 for 1 PLC scan.
Usage Output Data Type BOOL
Unit N/A Drive Parameter N/A
Minimum 0 Maximum 1
Visible Yes Required No
FB Parameter STS_JogActive
Description When set to 0, indicates that jog is not the active motion reference.
When set to 1, indicates that jog is the active motion reference.
Usage Output Data Type BOOL
Unit N/A Drive Parameter N/A
Minimum 0 Maximum 1
Visible Yes Required No
Page 87 of 127
Description When set to 0, indicates that run is not the active motion reference.
When set to 1, indicates that run is the active motion reference.
Usage Output Data Type BOOL
Unit N/A Drive Parameter N/A
Minimum 0 Maximum 1
Visible Yes Required No
FB Parameter STS_ReverseLimitSwitchOK
Description When set to 1, indicates that the reverse limit switch is not active.
When set to 0, indicates that the reverse limit switch is active
Usage Output Data Type BOOL
Unit N/A Drive Parameter Pr6.036
Minimum 0 Maximum 1
Visible Yes Required No
FB Parameter STS_ForwardLimitSwitchOK
Description When set to 1, indicates that the forward limit switch is not active.
When set to 0, indicates that the forward limit switch is active
Usage Output Data Type BOOL
Unit N/A Drive Parameter Pr6.035
Minimum 0 Maximum 1
Visible Yes Required No
FB Parameter STS_SpeedFollowingErrorLimitOK
Description When set to 1, indicates that the speed following error is within the limit
defined by CFG_SpeedFollowingErrorLimit.
When set to 0, indicates that the speed following error is not within the limit
defined by CFG_SpeedFollowingErrorLimit.
Usage Output Data Type BOOL
Unit N/A Drive Parameter Pr2.001 and Pr3.027
Minimum 0 Maximum 1
Visible Yes Required No
Page 88 of 127
Description Indicates the active error for the FB. The errors are assessed in the order
shown where the lower the error number the greater the priority. The user
may need to enter a correct value into an FB input to clear a persistent
error. STS_FB_ActiveError cannot be reset, the user must clear the current
error by rectifying the indicated error until STS_FB_ActiveError = 0. Some
of the errors may not be relevant for this particular FB.
The following list details the error values:
1 – 99 = Drive status, 100 - 999 = Internal input range errors, 1000+ User
input range errors.
• 0 = No error.
• 1 = Motion requested but STS_CyclicCommsOK = 0 or
CFG_CurrentLimit = 0 or CMD_DriveOn = 0.
• 2 = STS_CyclicCommsOK = FALSE.
• 3 = STS_DriveOK = FALSE.
• 4 = STS_HardwareTravelLimitPositiveOK = FALSE.
• 5 = STS_HardwareTravelLimitNegativeOK = FALSE.
• 6 = The drive mode does not match this FB. The FB will prevent the
axis from running. E.g. The CT_A_SpeedRPM FB is used but the
target drive is in open loop mode as indicated by Pr11.031.
• 7 = Motion Stop is activated. To reset motion stop set the selected
motion CMD bits to 0 when STS_CyclicCommsOK = 1.
• 100 = CFG_MotionStopDecelTime has been limited to a range of
0.0 to 3200.000.
• 101 = CFG_MotionStopSRampPercent has been limited to a range
of 0.0 to 50.0.
• 102 = CMD_JogForwards and CMD_JogReverse = 1.
• 103 = CFG_JogSpeed has been limited to a range of 0.0 to
MaxSpeed.
• 104 = CFG_JogAccelTime has been limited to a range of 0.0 to
3200.000.
• 105 = CFG_JogDecelTime has been limited to a range of 0.0 to
3200.000.
• 106 = CFG_JogSrampPercent has been limited to a range of 0.0 to
100.0.
• 107 = CMD_RunForward and CMD_RunReverse = 1.
• 108 = CFG_RunSpeed has been limited to a range of 0.0 to
CFG_MaxSpeed.
• 109 = CFG_RunAccelTime has been limited to a range of 0.0 to
3200.000.
• 110 = CFG_RunDecelTime has been limited to a range of 0.0 to
3200.000.
• 111= CFG_RunSRampPercent has been limited to a range of 0.0
to 100.0.
Page 89 of 127
FB Parameter STS_DriveActiveAlarm
FB Parameter STS_DriveLastTrip
Description Indicates the most recent target drive axis trip. Please refer to the UniM70x
user guide for more details.
Usage Output Data Type DINT
Unit N/A Drive Parameter Pr10.020
Minimum 0 Maximum 255
Visible Yes Required No
Page 90 of 127
Description Indicates the most recent target drive axis sub trip. Please refer to the
UniM70x user guide for more details.
Usage Output Data Type DINT
Unit N/A Drive Parameter Pr10.070
Minimum 0 Maximum 65536
Visible Yes Required No
FB Parameter STS_DrivePreRampSpeed
Description Indicates the Pre-ramp speed demand in rpm units. Fixed precision of 1
decimal place.
Usage Output Data Type REAL
Unit Rpm Drive Parameter Pr1.003
Minimum 0.0 Maximum 50000.0
Visible Yes Required No
FB Parameter STS_DrivePostRampSpeed
Description Indicates the target drive post-ramp speed in rpm units. Fixed precision of 1
decimal place.
Usage Output Data Type REAL
Unit Rpm Drive Parameter Pr2.001
Minimum 0.0 Maximum 50000.0
Visible Yes Required No
FB Parameter STS_DriveActualSpeed
Description Indicates the speed feedback from P1 device in rpm units. Fixed precision
of 1 decimal place.
Usage Output Data Type REAL
Unit Rpm Drive Parameter Pr3.027
Minimum -50000.0 Maximum 50000.0
Visible Yes Required No
Page 91 of 127
Description Indicates the target drive axis load as a percentage of motor rated current.
Fixed precision of 1 decimal place.
Usage Output Data Type REAL
Unit N/A Drive Parameter Pr4.020
Minimum -Rating dependant Maximum Rating dependant
Visible Yes Required No
Description Indicates the speed following error in 0.1 of motor rated current. Fixed
precision of 1 decimal place.
Usage Output Data Type REAL
Unit rpm Drive Parameter N/A
Minimum -50000.0 Maximum 50000.0
Visible Yes Required No
Page 92 of 127
5.8.1 STS_DriveOn
STS_DriveActualSpeed
CMD_DriveOn
STS_DriveOK
STS_DriveEnabled
CMD_xForward or
CMD_xReverse
STS_DriveOn
Time
x = Jog or Run
STS_DriveActualSpeed
CMD_JogForward
CMD_JogReverse
CMD_MotionStop
STS_JogActive
STS_MotionStopActive
STS_DriveAtZeroSpeed
Time
Page 93 of 127
STS_DriveActualSpeed
CMD_RunForward
CMD_RunReverse
CMD_MotionStop
STS_RunActive
STS_MotionStopActive
STS_DriveAtZeroSpeed
Time
STS_DriveOutputSpeed
CMD_JogForward
CMD_RunForward
STS_JogActive
STS_RunActive
Page 94 of 127
6.1 CT_B_M7xxM6xxDriveStatusWord
The CT_B_M7xxM6xxDriveStatus FB decodes cyclic data originated from the target drive status
word, (Pr10.040). This source data is available as part of the open and closed loop PROFINET cyclic
data input mappings via #CyclicDataIn. The status word is decoded to produce 15 individual Boolean
values as listed in the parameter guide for (Pr10.040).
Page 95 of 127
3. The “Call options” dialog will open. Rename the Data block so that the axis name is
referenced e.g. DriveStatusWord_A1_DB. Click “OK” when this has been done.
Page 96 of 127
4. Link the instance of CT_B_M7xxM6xxDriveStatusWord to the input data from the axis. Double
click the next to “#CyclicDataIn” on the new instance of
CT_B_M7xxM6xxDriveStatusWord, and then click and select ““#CyclicDataIn”.
5. Access the data by dot syntax via the data block name e.g.
“DriveStatusWord_A1_DB”.AtSpeed.
Page 97 of 127
FB Parameter CyclicDataIn
Description The function block interface to the PROFINET cyclic input mapping data.
Each DINT element in the array represents a value received from the target
drive by the PLC.
This must be linked to the #CyclicDataIn tag connected to the instance of
the ReadInputData xxx function block for the axis.
Page 98 of 127
Page 99 of 127
8. The “Call options” dialog will open. Rename the Data block so that the axis name is
referenced e.g. DriveDigitalIoWord_A1_DB. Click “OK” when this has been done.
9. Link the instance of CT_B_M7xxM6xxDigitalIoReadWord to the input data from the axis.
Double click the next to “#CyclicDataIn” on the new instance of
CT_B_M7xxM6xxDigitalIoReadWord, and then click and select ““#CyclicDataIn”.
10. Access the data by dot syntax via the data block name e.g.
"DriveDigitalIoWord_A1_DB".DigitalInput4.
FB Parameter CyclicDataIn
Description The function block interface to the PROFINET cyclic input mapping data. Each
DINT element in the array represents a value received from the target drive by
the PLC.
This must be linked to the #CyclicDataIn tag connected to the instance of the
ReadInputData xxx function block for the axis.
Description This bit represents target drive parameter Pr08.005, which indicates the
state of Digital input 5.
Usage Output Data Type Bool
Unit N/A Drive Parameter 08.072 bit 4
Minimum 0 Maximum 1
Visible Yes Required No
13. The “Call options” dialog will open. Rename the Data block so that the axis name is
referenced e.g. DriveAdditionalStatusBits_A1_DB. Click “OK” when this has been done.
14. Link the instance of CT_B_M7xxM6xxAdditionalStatusBits to the input data from the axis.
Double click the next to “#CyclicDataIn” on the new instance of
CT_B_M7xxM6xxAdditionalStatusBits, and then click and select ““#CyclicDataIn”.
15. Access the data by dot syntax via the data block name e.g.
"DriveAdditionalStatusBits_A1_DB".MotorOverloadAlarm.
FB Parameter CyclicDataIn
Description The function block interface to the PROFINET cyclic input mapping data. Each
DINT element in the array represents a value received from the target drive by
the PLC.
This must be linked to the #CyclicDataIn tag connected to the instance of the
ReadInputData xxx function block for the axis.
FB Parameter UnderVoltageActive
Description This bit represents target drive parameter Pr10.016, which indicates that
the drive is in a under voltage state.
Usage Output Data Type BOOL
Unit N/A Drive Parameter Pr10.069 bit 0
Minimum 0 Maximum 1
Visible Yes Required No
Description This bit represents target drive parameter Pr10.017, which indicates that
the motor overload accumulator is above 75% and the output current is
high.
Usage Output Data Type BOOL
Unit N/A Drive Parameter Pr10.069 bit 1
Minimum 0 Maximum 1
Visible Yes Required No
FB Parameter DriveOverTemperatureAlarm
Description This bit represents target drive parameter (Pr10.018), which indicates that
the drive over-temperature alarm is active.
Usage Output Data Type BOOL
Unit N/A Drive Parameter Pr10.069 bit 2
Minimum 0 Maximum 1
Visible Yes Required No
FB Parameter DriveWarning
Description This bit represents target drive parameter Pr10.019, which indicates that
one or more of the drive warning alarms are active.
Usage Output Data Type BOOL
Unit N/A Drive Parameter 10.069 bit 3
Minimum 0 Maximum 1
Visible Yes Required No
FB Parameter LowLoadDetectedAlarm
Description This bit represents target drive parameter Pr10.062, which indicates that
the low load alarm is active.
Usage Output Data Type BOOL
Unit N/A Drive Parameter Pr10.069 bit 4
Minimum 0 Maximum 1
Visible Yes Required No
Description This bit represents target drive parameter Pr10.063, which indicates that
the real time clock battery in the local keypad is low.
Usage Output Data Type BOOL
Unit N/A Drive Parameter Pr10.069 bit 5
Minimum 0 Maximum 1
Visible Yes Required No
FB Parameter RemoteKeypadBatteryLow
Description This bit represents target drive parameter Pr10.064, which indicates that
the real time clock battery in the local keypad is low.
Usage Output Data Type BOOL
Unit N/A Drive Parameter Pr10.069 bit 6
Minimum 0 Maximum 1
Visible Yes Required No
FB Parameter AutotuneActive
Description This bit represents target drive parameter Pr10.065, which indicates that an
auto-tune sequence is active.
Usage Output Data Type BOOL
Unit N/A Drive Parameter Pr10.069 bit 7
Minimum 0 Maximum 1
Visible Yes Required No
FB Parameter LimitSwitchActive
Description This bit represents target drive parameter Pr10.066, which indicates that a
limit switch is enabled and active.
Usage Output Data Type BOOL
Unit N/A Drive Parameter Pr10.069 bit 8
Minimum 0 Maximum 1
Visible Yes Required No
Description This bit represents target drive parameter Pr10.067, which indicates that
fire mode is enabled and active
Usage Output Data Type BOOL
Unit N/A Drive Parameter Pr10.069 bit 9
Minimum 0 Maximum 1
Visible Yes Required No
17. Navigate to the CT_B_M7xxAMC_Status function block by selecting “Project tree > Devices >
PLC > Program blocks > System > System Function Blocks > Status >
CT_B_M7xxAMC_Status”. Click and drag CT_B_M7xxAMC_Statusto the right of the
ReadInputData xxx function block e.g. "ReadInputDataPositionAMC_A1".
18. The “Call options” dialog will open. Rename the Data block so that the axis name is
referenced e.g. AMC_Status_A1_DB. Click “OK” when this has been done.
19. Link the instance of CT_B_M7xxAMC_Status to the input data from the axis. Double click the
next to “#CyclicDataIn” on the new instance of CT_B_M7xxAMC_Status, and then click
and select ““#CyclicDataIn”.
20. Access the data by dot syntax via the data block name e.g.
"DriveAdditionalStatusBits_A1_DB".MotorOverloadAlarm.
FB Parameter CyclicDataIn
Description The function block interface to the PROFINET cyclic input mapping data.
Each DINT element in the array represents a value received from the target
drive by the PLC.
This must be linked to the #CyclicDataIn tag connected to the instance of
the ReadInputData xxx function block for the axis.
Description This bit represents target drive parameter Pr37.006, which indicates
when the electronic gearbox is locked.
Usage Output Data Type BOOL
Unit N/A Drive Parameter Pr41.002 Bit 0
Minimum 0 Maximum 1
Visible Yes Required No
Description This bit represents target drive parameter Pr35.010, which indicates
when the cam controller reaches the end of the cam table.
Usage Output Data Type BOOL
Unit N/A Drive Parameter Pr41.002 Bit 1
Minimum 0 Maximum 1
Visible Yes Required No
Description This bit represents target drive parameter Pr41.004, which indicates the
AMC has completed its position profile and the drive is at zero speed.
Usage Output Data Type BOOL
Unit N/A Drive Parameter Pr41.002 Bit 2
Minimum 0 Maximum 1
Visible Yes Required No
Description This bit represents target drive parameter Pr41.006, which indicates the
AMC Profile has Completed.
Usage Output Data Type BOOL
Unit N/A Drive Parameter Pr41.002 Bit 3
Minimum 0 Maximum 1
Visible Yes Required No
Description This bit represents target drive parameter Pr41.008, which indicates the
AMC reference position and actual position difference is great than the
given parameter.
Usage Output Data Type BOOL
Unit N/A Drive Parameter Pr41.002 Bit 4
Minimum 0 Maximum 1
Visible Yes Required No
Description This bit represents target drive parameter Pr41.010, which indicates the
AMC profile output speed is on target.
Usage Output Data Type BOOL
Unit N/A Drive Parameter Pr41.002 Bit 5
Minimum 0 Maximum 1
Visible Yes Required No
Description This bit represents target drive parameter Pr41.011, which indicates the
AMC master speed is greater than the AMC profile max speed value.
Usage Output Data Type BOOL
Description This bit represents target drive parameter Pr41.012, which indicates the
AMC Reference position has exceeded the AMC following window value.
Usage Output Data Type BOOL
Unit N/A Drive Parameter Pr41.002 Bit 7
Minimum 0 Maximum 1
Visible Yes Required No
Description This bit represents target drive parameter Pr40.005, which indicates the
AMC Homing task has completed all phases.
Usage Output Data Type BOOL
Unit N/A Drive Parameter Pr41.002 Bit 8
Minimum 0 Maximum 1
Visible Yes Required No
Description This bit represents target drive parameter Pr40.008, which indicates the
AMC Homing position and Home offset position are within range of AMC
Home complete window.
Usage Output Data Type BOOL
Unit N/A Drive Parameter Pr41.002 Bit 9
Minimum 0 Maximum 1
Visible Yes Required No
Description This bit represents target drive parameter Pr41.013, which indicates the
state of the Forward limit switch (Pr06.035)
Usage Output Data Type BOOL
Unit N/A Drive Parameter Pr41.002 Bit 10
Description This bit represents target drive parameter Pr41.014, which indicates the
state of the Reverse limit switch (Pr06.036)
Usage Output Data Type BOOL
Unit N/A Drive Parameter Pr41.002 Bit 11
Minimum 0 Maximum 1
Visible Yes Required No
Description This bit represents target drive parameter Pr41.015, which indicates the
state of the AMC positive position limit compared to the AMC slave
position.
Usage Output Data Type BOOL
Unit N/A Drive Parameter Pr41.002 Bit 12
Minimum 0 Maximum 1
Visible Yes Required No
Description This bit represents target drive parameter Pr41.016, which indicates the
state of the AMC negative position limit compared to the AMC slave
position.
Usage Output Data Type BOOL
Unit N/A Drive Parameter Pr41.002 Bit 13
Minimum 0 Maximum 1
Visible Yes Required No
Description This bit represents target drive parameter Pr41.017, which indicates the
AMC Home Required Flag is set to 1 if AMC Home Required (Pr40.020)
is enabled and AMC Home Slave Source (Pr40.021) is not the same as
AMC Slave Source Select (Pr33.001).
Usage Output Data Type BOOL
Unit N/A Drive Parameter Pr41.002 Bit 14
Description This bit represents target drive parameter Pr41.018, which indicates
when the AMC master and slave position accumulators have been
initialised.
Usage Output Data Type BOOL
Unit N/A Drive Parameter Pr41.002 Bit 15
Minimum 0 Maximum 1
Visible Yes Required No
Description Indicates the active error for the FB. The errors are assessed in the order
shown where the lower the error number the greater the priority. The user
may need to enter a correct value into an FB input to clear a persistent
error. STS_FB_ActiveError cannot be reset, the user must clear the current
error by rectifying the indicated error until STS_FB_ActiveError = 0. Some
of the errors may not be relevant for this particular FB.
The following list details the error values:
1 – 99 = Drive status, 100 - 999 = Internal input range errors, 1000+ User
input range errors.
• 0 = No error.
• 1 = Motion requested but STS_CyclicCommsOK = 0 or
CFG_CurrentLimit = 0 or CMD_DriveOn = 0.
• 2 = STS_CyclicCommsOK = FALSE.
• 3 = STS_DriveOK = FALSE.
• 4 = STS_HardwareTravelLimitPositiveOK = FALSE.
• 5 = STS_HardwareTravelLimitNegativeOK = FALSE.
• 6 = The drive mode does not match this FB. The FB will prevent the
axis from running. E.g. The CT_A_SpeedRPM FB is used but the
target drive is in open loop mode as indicated by Pr11.031.
• 7 = Motion Stop is activated. To reset motion stop set the selected
motion CMD bits to 0 when STS_CyclicCommsOK = 1.
• 100 = CFG_MotionStopDecelTime has been limited to a range of
0.0 to 3200.000.
• 101 = CFG_MotionStopSRampPercent has been limited to a range
of 0.0 to 50.0.
• 102 = CMD_JogForwards and CMD_JogReverse = 1.
• 103 = CFG_JogSpeed has been limited to a range of 0.0 to
MaxSpeed.
• 104 = CFG_JogAccelTime has been limited to a range of 0.0 to
3200.000.
• 105 = CFG_JogDecelTime has been limited to a range of 0.0 to
3200.000.
• 106 = CFG_JogSRampPercent has been limited to a range of 0.0
to 100.0.
• 107 = CMD_RunForward and CMD_RunReverse = 1.
• 108 = CFG_RunSpeed has been limited to a range of 0.0 to
CFG_MaxSpeed.
• 109 = CFG_RunAccelTime has been limited to a range of 0.0 to
3200.000.