Professional Documents
Culture Documents
Documentation of The Library Wagoappstepper: Release 1.6.1.1
Documentation of The Library Wagoappstepper: Release 1.6.1.1
Documentation of The Library Wagoappstepper: Release 1.6.1.1
WagoAppStepper
Release 1.6.1.1
Contents
1 Description 1
i
3 80 Status 55
3.1 Status (GVL) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
3.2 eStatus (ENUM) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
4 ParameterList (PARAMS) 62
5 VersionHistory (GVL) 63
6 Library Reference 64
ii
CHAPTER 1
Description
This document is automatically generated. Because of this, the chapter 30 Visualization is not shown in this
document. If you are interested in getting to know more about visualization, we refer to the library manager of
e!Cockpit.
Subject to Changes
WAGO Kontakttechnik GmbH Co. KG reserves the right to provide for any alterations or modifications. WAGO
Kontakttechnik GmbH Co. KG owns all rights arising from the granting of patents or from the legal protection
of utility patents. Third-party products are always mentioned without any reference to patent rights. Thus, the
existence of such rights cannot be excluded.
Personnel Qualification
All tasks that are carried out with libraries made for the e!COCKPIT software must only be performed by qualified
electrical specialists instructed in PLC programming according to IEC 61131-3.
All tasks that have an effect on the properties or the behavior of automation hardware or software products must
only be performed by qualified employees with a thorough knowledge of handling the products concerned.
Intended Use of e!COCKPIT Libraries
Libraries created for the e!COCKPIT software are used to simplify the development of application projects in the
IEC 61131-3 programming languages.
For automation tasks, WAGO offers programmable logic controllers in a wide variety of performance classes.
In combination with a wide range of I/O modules, the controllers can process standard types of field signals.
Controllers can be implemented centrally or in decentralized configurations. The controllers offer interfaces for
the most commonly used fieldbuses for use in decentralized configurations. Fieldbus independent I/O modules
are then linked via fieldbus couplers. WAGO controllers offer a runtime environment for user programs called
e!RUNTIME. Software projects for implementation in e!RUNTIME environments can be created in e!COCKPIT.
The programming environment in e!COCKPIT is based on the established CODESYS 3 industrial standard. Users
with a previous knowledge of CODESYS 3 will thus find this environment largely familiar. The following pro-
gramming languages of the IEC 61131-3 standard are available:
• Structured Text (ST)
• Ladder Diagram (LD)
• Function Block Diagram (FBD)
• Instruction List (IL)
• Sequential Function Chart (SFC)
• Continuous Function Chart (CFC)
The individual programming languages can also be combined as required during the development of the software.
A portfolio of prepared libraries can be accessed for many frequently used functions in order to make software
development more efficient. This document provides an overview of the WagoAppStepper that WAGO offers for
e!COCKPIT.
1
WagoAppStepper, Release 1.6.1.1
2
CHAPTER 2
2.1 Additional
Interface variables
Function description
The positioning job is defined by the inputs iSpeed, wAcceleration and diPosition. The parameter
iSpeed is allowed in the range of 1..25000 while wAcceleration is allowed from 0..32767. The job will be
started by the variable xEnable. Parameter changes(iSpeed or diPosition) on the fly are supported.
3
WagoAppStepper, Release 1.6.1.1
Interface variables
Function description
This block allows changes of the velocity on the fly, so there is no need to disable the block if a new speed value
is assigned. This behaviour is different to FbMoveVelocity.
Attention: If used with module 750-670 and 750-671 this block modifies the configuration value “Applica-
tion_Selector”! Please make sure this value is reset by the application programm in case of e.g. absolute po-
sitioning.
2.1. Additional 4
WagoAppStepper, Release 1.6.1.1
InOut:
InOut:
InOut:
InOut:
InOut:
InOut:
InOut:
InOut:
Interface variables
Function description
Reading and writing of the terminals internal cam table RAM 1
Interface variables
Function description
This functionblock allows to read and write the configuration table at once. To start the process set xExecute
to TRUE. If the action is finished the output xDone becomes True. The output oStatus shows any error. After
writing the configuration table the modul resets itself. Therefore the actual position will be reset to Zero.
Visualization
For each module a visualisation template tplConfiguration_67x is available. The data structure
typConfiguration_67x contains the default values. The visualisation template shows the most important
values. This template needs the instance of the function block FbConfigurationTable as input.
Interface variables
Function description
This functionblock allows to read and write a single parameter from the configuration table. Writing differentiates
between temporarily changes(write to ram) which are lost after power on of the stepper modul and permanent(write
to flash) changes.
Interface variables
Function description
This functionblock allows to execute a drive program. The input wStartPositionDriveProgram allows to
determine the start address within the drive program. While setting up drive program mode, the output oStatus will
show “InProgress”. If the initialization is finished status OK will be set. Initialization will not start, if the function
block FbPower is not active or the function block FbStop is activated. The variable wActualDriveProgramPosition
shows the ProgramPosition of the next Position.
Interface variables
Function
Reading and writing of the terminals internal drive program table
Graphical Illustration
Function description
If the input xWriteFlash is True the drive program will be stored to the flash memory after it is downloaded to the
module. After power on reset the drive program is therefore still available and can be directly executed by using
the function block FbDriveProgram.
Interface variables
Interface variables
Function description
This function block allows to start a homing job. Please make sure either xRefPositive or xRefNegative
is choosen if the input “xExecute” becomes high. Homing mode, speed and acceleration a configured by the
configuration table (Reference_Mode,SetupSpeed and SetupAcceleration).
Interface variables
Interface variables
Function description
The jogging is performed by digital inputs direct on the module.
Interface variables
Function description
The input wAcceleration will be taken for the decelarion as well. The job will be started by the variable
xExecute. Parameter changes on the fly are not supported.
Interface variables
Interface variables
Function
A base function block which allows a torque movement of a stepper drive using module 750-673
Graphical Illustration
Interface variables
Interface variables
Function description
Attention: If used with module 750-670 and 750-671 this block modifies the configuration value “Applica-
tion_Selector”! Please make sure this value is reset by the application programm in case of e.g. absolute po-
sitioning. Please use FbConfigurationValue.
Interface variables
Function description
High wAcceleration values ensure a quick increase of the pulswidth rate. Additional it may be necessary to
increase the default value for ACC_Fact(see the configuration table) from 80 to 10000 to archieve an even steeper
increase. Once started, changes in the input parameters will only be overtaken by a positive edge of the xEnable
input.
Interface variables
Function description
This function block allows to read and write the position table. Each position in the table is 4 byte long. Input
bDataCount is the number of positions in the table. The size of the position table may be changed through
POSITION_TABLE_SIZE in the parameter list.
Interface variables
Function
Enable the power stage of a stepper drive
Graphical Illustration
Function description
This function block must be used except for running the stepper drive by the function block FbStepperControlBa-
sic. Bit 0 in the Control Byte 1 ist directly controlled. The output xStatus displays directly Bit 0 from Status
Byte 1.
Interface variables
Function description
This function block shows the actual position as well as the actual speed. The output bActualMode displays the
operating modes according to the enumeration eMode:
Interface variables
Function description
If the module status 2.7 (error) is TRUE, the output xMouduleFault is set. If an error occured, detailed infor-
mation will be read, using the mailbox command 0x49 ERR_GET. The details will be displayed in eFeedback.
Output xError will only be set, if the mailbox command 0x49 shows an error. The output xModuleFault
will show directly status byte Status2.7.
Interface variables
Function description
This function block performs a reset. Bit 7 in the Control Byte 3 and Control Byte 2 ist directly controlled
Interface variables
Function
Restore Default values
Graphical Illustration
Interface variables
Graphical Illustration
Interface variables
Interface variables
Function description
• Absolute positioning The positioning job is defined by the inputs iSpeed, wAcceleration, wDeceleration and
diPosition. The parameter iSpeed is allowed in the range of 1..25000 while acceleration and deceleration
are allowed from 0..32767. The job will be started by the variable xTriggerStart. If the job is done, the
variable xTriggerStart will be reset by the functionblock.
• Relative positioning The positioning job is defined by the inputs iSpeed, wAcceleration, wDeceleration and
diPosition. The parameter iSpeed is allowed in the range of 1..25000 while acceleration and deceleration
are allowed from 0..32767. The job will be started by the variable xTriggerStart. If the job is done, the
variable xTriggerStart will be reset by the functionblock.
• Homing The Homing job is defined by the inputs xDirPos or xDirNeg and xTriggerStart. The job will
be started by the variable xTriggerStart. If the job is done, the variable xTriggerStart will be reset by the
functionblock. Homing speed, acceleration and mode are defined through the values in the configuration
table.
• Jogging Depending on the module the jogging mode is started differently. 750-670,750-671: The Jogging
job is defined by the inputs xDirPos or xDirNeg and xTriggerStart. The job will be started by the variable
xDirPos or xDirNeg and xTriggerStart=True, and runs as long as the appropriate input xDirPos or xDirNeg
is true. Jogging speed and acceleration are defined through the values in the configuration table(SetupSpeed
and SetupAcceleration).
750-672,750-673: The Jogging job is defined by the input xTriggerStart. The job will be started by phys-
ical inputs of the module. Jogging speed and acceleration are defined through the values in the config-
uration table(SetupSpeed and SetupAcceleration). Output xBusy will be True, if the stepper is actually
jogging(xJobfinished without any meaning in this operation mode).
• Velocity Control The Velocity control job is defined by the inputs iSpeed, wAcceleration, wDecceleration.
The parameter iSpeed is allowed in the range of -25000..25000.
While running it is possible to change the speed. Therfore the input iSpeed has to be set to the new speed
and the xTriggerStart variable needs to be set again.
• Drive Program This mode expects a drive program table within the stepper module. This program will be
started at table index diPosition when xTriggerStart becomes true.
• General Inputs: The input xEnable needs to be true to run the stepper. If this variable is set to zero the
module will stop immediately without any ramp. By xEnable=True the power stage of the module will be
enabled. xTriggerStart needs to be set by the user to start serveral jobs. This inout variable will be reset by
the function block(except for jogging mode). Once a job is started no action will be taken by the function
block, if the user resets the variable (silently ignored).
If a job is choosen and the input eMode is changed while the job is still active, a stop will be performed.
The input xStop will stop each movement. The stop ramp is defined by the configuration parameter Accel-
eration_Stop_Fast (address 46).
xReset allows to reset an error.
• General Outputs: xJobFinished indicates that a positioning or homing job is finished. In case of the ve-
locity control mode this output indicates that the reference speed is reached. xBusy is high while a job is
running xMailBoxActive indicates, that the values for diActualPosition and diActualSpeed are latched and
will no be updated any more xError indicates any error eErrorCodes shows details according to the enumer-
ation eFeedbackStatus in verbal form oStatus shows detailed status information xResetWarning indicates a
warmstart of the module. This output correspondends directly to status byte S3.7 as described in the stepper
manual.
• MoveAbsolute: iSpeed, wAcceleration, diPosition On the fly changes (iSpeed or wAcceleration or diPosi-
tion) are not supported
• Homing: eJobType=Homing either xDirPos=TRUE or xDirNeg=TRUE ->otherwise CommandError
• Velocity Control: xTriggerStart As long as xTriggerStart is TRUE, the values for iSpeed,wAcceleration and
wDeceleration may be changed during an active command. To stop a velocity movement, eihter set speed
to ZERO or use “xStop” input.
• Jogging: xTriggerStart must be set to true to ativate jog mode. In this operation mode, the variable must be
reset by the user, if the jogging mode should be finished. 670,671: Jogging will be performed if either input
xDirPos or xDirNeg becomes high 672,673: Jogging will be performed if either module input DI3 or DI4
becomes high
Visualization
For each module a visualisation template tplMoveStepper_67x is available. The input m_input_drive of the
visualisation template is of type typStepperVisu_67x. According to this example the input m_input_drive
must be assigned by Stepper1.
Interface variables
Function description
This function block must be used except for running the stepper drive by the function block FbStepperControlBa-
sic. This functionblock allows to stop the stepper motor. The deceleration ramp is determined by the configuration
value AccelerationStopFast.
Interface variables
80 Status
55
WagoAppStepper, Release 1.6.1.1
InOut:
ParameterList (PARAMS)
62
CHAPTER 5
VersionHistory (GVL)
Name Type
ProjectInfo
Info
WagoAppStepper.library
date version author change
12.06.2019 1.6.1.1 u010663 Library inserted by placeholder
08.01.2019 1.6.1.0 u015842 Properties: free placeholder added
14.09.2018 1.6.0.12 u010663 Bugfix FbPWM_Mode_670
27.11.2017 1.6.0.10 u010663 Bugfix FbMoveAbsolute_2
29.05.2017 1.6.0.9 u010663 Bugfix FbMoveRelative
27.04.2017 1.6.0.8 u010663 Bugfix FbStepperControlBasic
27.03.2017 1.6.0.7 u010663 Bugfix FbStepperControlBasic in jog mode
19.01.2017 1.6.0.6 u010663 FbStepperControlBasis allow “Change on the Fly” for absolute
positioning jobs
25.11.2015 1.6.0.5 u010663 Add FbCAM_Table
16.06.2015 1.5.0.0 u010663 Released
Release Notes:
63
CHAPTER 6
Library Reference
Standard
Library Identification:
Placeholder: Standard
Default Resolution: Standard, * (System)
Namespace: Standard
Library Properties:
• LinkAllContent: False
• QualifiedOnly: False
• SystemLibrary: False
• Optional: False
VisuDialogs
Library Identification:
Placeholder: VisuDialogs
Default Resolution: VisuDialogs, * (System)
Namespace: VisuDialogs
Library Properties:
• LinkAllContent: False
• Optional: False
• QualifiedOnly: False
• SystemLibrary: False
• PublishSymbolsInContainer: True
VisuElem3DPath
Library Identification:
Placeholder: System_VisuElem3DPath
Default Resolution: VisuElem3DPath, 3.5.10.0 (System)
Namespace: VisuElem3DPath
64
WagoAppStepper, Release 1.6.1.1
Library Properties:
• LinkAllContent: False
• QualifiedOnly: False
• SystemLibrary: True
• Optional: False
Library Parameter:
Parameter: GC_POINTS_PER_POLYGON = 100
VisuElemCamDisplayer
Library Identification:
Placeholder: System_VisuElemCamDisplayer
Default Resolution: VisuElemCamDisplayer, 3.5.10.0 (System)
Namespace: VisuElemCamDisplayer
Library Properties:
• LinkAllContent: False
• QualifiedOnly: False
• SystemLibrary: True
• Optional: False
Library Parameter:
Parameter: GC_POINTS_PER_CAM = 100
VisuElemMeter
Library Identification:
Placeholder: System_VisuElemMeter
Default Resolution: VisuElemMeter, 3.5.10.0 (System)
Namespace: VisuElemMeter
Library Properties:
• LinkAllContent: False
• QualifiedOnly: False
• SystemLibrary: True
• Optional: False
VisuElemTextEditor
Library Identification:
Placeholder: System_VisuElemTextEditor
Default Resolution: VisuElemTextEditor, 3.5.10.0 (System)
Namespace: VisuElemTextEditor
Library Properties:
65
WagoAppStepper, Release 1.6.1.1
• LinkAllContent: False
• QualifiedOnly: False
• SystemLibrary: True
• Optional: False
VisuElemTrace
Library Identification:
Placeholder: System_VisuElemTrace
Default Resolution: VisuElemTrace, 3.5.10.0 (System)
Namespace: VisuElemTrace
Library Properties:
• LinkAllContent: False
• QualifiedOnly: False
• SystemLibrary: True
• Optional: False
VisuElemXYChart
Library Identification:
Placeholder: System_VisuElemXYChart
Default Resolution: VisuElemXYChart, 3.5.14.0 (System)
Namespace: VisuElemXYChart
Library Properties:
• LinkAllContent: False
• QualifiedOnly: False
• SystemLibrary: True
• Optional: False
VisuElems
Library Identification:
Placeholder: System_VisuElems
Default Resolution: VisuElems, 3.5.10.0 (System)
Namespace: VisuElems
Library Properties:
• LinkAllContent: False
• QualifiedOnly: False
• SystemLibrary: True
• Optional: False
VisuElemsAlarm
Library Identification:
Placeholder: System_VisuElemsAlarm
66
WagoAppStepper, Release 1.6.1.1
Library Properties:
• LinkAllContent: False
• QualifiedOnly: False
• SystemLibrary: True
• Optional: False
VisuElemsDateTime
Library Identification:
Placeholder: System_VisuElemsDateTime
Default Resolution: VisuElemsDateTime, 3.5.10.0 (System)
Namespace: VisuElemsDateTime
Library Properties:
• LinkAllContent: False
• QualifiedOnly: False
• SystemLibrary: True
• Optional: False
VisuElemsSpecialControls
Library Identification:
Placeholder: System_VisuElemsSpecialControls
Default Resolution: VisuElemsSpecialControls, 3.5.10.0 (System)
Namespace: VisuElemsSpecialControls
Library Properties:
• LinkAllContent: False
• QualifiedOnly: False
• SystemLibrary: True
• Optional: False
VisuElemsWinControls
Library Identification:
Placeholder: System_VisuElemsWinControls
Default Resolution: VisuElemsWinControls, 3.5.10.0 (System)
Namespace: VisuElemsWinControls
Library Properties:
• LinkAllContent: False
• QualifiedOnly: False
• SystemLibrary: True
67
WagoAppStepper, Release 1.6.1.1
• Optional: False
VisuInputs
Library Identification:
Placeholder: system_visuinputs
Default Resolution: VisuInputs, 3.5.14.0 (System)
Namespace: visuinputs
Library Properties:
• LinkAllContent: False
• Optional: False
• QualifiedOnly: False
• SystemLibrary: True
• PublishSymbolsInContainer: True
VisuNativeControl
Library Identification:
Placeholder: System_VisuNativeControl
Default Resolution: VisuNativeControl, 3.5.10.0 (System)
Namespace: VisuNativeControl
Library Properties:
• LinkAllContent: False
• QualifiedOnly: False
• SystemLibrary: True
• Optional: False
VisuSymbols
Library Identification:
Name: VisuSymbols
Version: 3.5.7.0
Company: System
Namespace: VisuSymbols
Library Properties:
• LinkAllContent: False
• QualifiedOnly: True
• SystemLibrary: True
• Optional: False
• PublishSymbolsInContainer: True
WagoSysErrorBase
Library Identification:
Placeholder: WagoSysErrorBase
68
WagoAppStepper, Release 1.6.1.1
Library Properties:
• LinkAllContent: False
• QualifiedOnly: False
• SystemLibrary: False
• Optional: False
WagoSysVersion
Library Identification:
Name: WagoSysVersion
Version: 1.0.0.0
Company: WAGO
Namespace: WagoSysVersion
Library Properties:
• LinkAllContent: False
• QualifiedOnly: False
• SystemLibrary: False
• Optional: False
WagoTypesErrorBase
Library Identification:
Placeholder: WagoTypesErrorBase
Default Resolution: WagoTypesErrorBase, * (WAGO)
Namespace: WagoTypesErrorBase
Library Properties:
• LinkAllContent: False
• QualifiedOnly: True
• SystemLibrary: False
• Optional: False
WagoTypesModuleBase
Library Identification:
Placeholder: WagoTypesModuleBase
Default Resolution: WagoTypesModuleBase, * (WAGO)
Namespace: WagoTypesModuleBase
Library Properties:
• LinkAllContent: False
• QualifiedOnly: True
69
WagoAppStepper, Release 1.6.1.1
• SystemLibrary: False
• Optional: False
Library Parameter:
Parameter: MAX_MBX_SIZE = 18
WagoTypesModule_75x_67x
Library Identification:
Placeholder: WagoTypesModule_75x_67x
Default Resolution: WagoTypesModule_75x_67x, * (WAGO)
Namespace: WagoTypesModule_75x_67x
Library Properties:
• LinkAllContent: False
• QualifiedOnly: True
• SystemLibrary: False
• Optional: False
WagoVisuIcons
Library Identification:
Placeholder: WagoVisuIcons
Default Resolution: WagoVisuIcons, * (WAGO)
Namespace: WagoVisuIcons
Library Properties:
• LinkAllContent: False
• QualifiedOnly: False
• SystemLibrary: False
• Optional: False
© WAGO Kontakttechnik GmbH & Co. KG, Germany 2018 – All rights reserved. For the avoidance of doubt,
this copyright notice does not only apply to the information above but also and primarily to the described library
itself. Please note that third-party products are always mentioned without reference to intellectual property rights,
including patents, utility models, designs and trademarks, accordingly the existence of such rights cannot be
excluded. WAGO is a registered trademark of WAGO Verwaltungsgesellschaft mbH.
70