RwPar Functions en-US
RwPar Functions en-US
1
______________
Description
2
SIMOTION ______________
Function block
3
______________
Example of an application
Function Manual
08/2008 Edition
Safety Guidelines
Safety Guidelines
This manual contains notices you have to observe in order to ensure your personal safety, as well as to prevent
damage to property. The notices referring to your personal safety are highlighted in the manual by a safety alert
symbol, notices referring only to property damage have no safety alert symbol. These notices shown below are
graded according to the degree of danger.
DANGER
indicates that death or severe personal injury will result if proper precautions are not taken.
WARNING
indicates that death or severe personal injury may result if proper precautions are not taken.
CAUTION
with a safety alert symbol, indicates that minor personal injury can result if proper precautions are not taken.
CAUTION
without a safety alert symbol, indicates that property damage can result if proper precautions are not taken.
NOTICE
indicates that an unintended result or situation can occur if the corresponding information is not taken into
account.
If more than one degree of danger is present, the warning notice representing the highest degree of danger will
be used. A notice warning of injury to persons with a safety alert symbol may also include a warning relating to
property damage.
Qualified Personnel
The device/system may only be set up and used in conjunction with this documentation. Commissioning and
operation of a device/system may only be performed by qualified personnel. Within the context of the safety notes
in this documentation qualified persons are defined as persons who are authorized to commission, ground and
label devices, systems and circuits in accordance with established safety practices and standards.
Prescribed Usage
Note the following:
WARNING
This device may only be used for the applications described in the catalog or the technical description and only
in connection with devices or components from other manufacturers which have been approved or
recommended by Siemens. Correct, reliable operation of the product requires proper transport, storage,
positioning and assembly as well as careful operation and maintenance.
Trademarks
All names identified by ® are registered trademarks of the Siemens AG. The remaining trademarks in this
publication may be trademarks whose use by third parties for their own purposes could violate the rights of the
owner.
Disclaimer of Liability
We have reviewed the contents of this publication to ensure consistency with the hardware and software
described. Since variance cannot be precluded entirely, we cannot guarantee full consistency. However, the
information in this publication is reviewed regularly and any necessary corrections are included in subsequent
editions.
Function block
The function block for the "Reading and Writing of Drive Data" for SIMOTION is part of the
command library of the "SIMOTION SCOUT" engineering system.
SIMOTION Documentation
An overview of the SIMOTION documentation can be found in a separate list of references.
This documentation is included as electronic documentation with the supplied SIMOTION
SCOUT.
The SIMOTION documentation consists of 9 documentation packages containing
approximately 80 SIMOTION documents and documents on related systems (e.g.
SINAMICS).
The following documentation packages are available for SIMOTION V4.1 SP2:
● SIMOTION Engineering System
● SIMOTION System and Function Descriptions
● SIMOTION Diagnostics
● SIMOTION Programming
● SIMOTION Programming - References
● SIMOTION C
● SIMOTION P350
● SIMOTION D4xx
● SIMOTION Supplementary Documentation
Technical support
If you have any technical questions, please contact our hotline:
Europe / Africa
Phone +49 180 5050 222 (subject to charge)
Fax +49 180 5050 223
Internet http://www.siemens.com/automation/support-request
Americas
Phone +1 423 262 2522
Fax +1 423 262 2200
E-mail mailto:[email protected]
Asia / Pacific
Phone +86 1064 719 990
Fax +86 1064 747 474
E-mail mailto:[email protected]
Note
Country-specific telephone numbers for technical support are provided under the following
Internet address:
http://www.siemens.com/automation/service&support
Calls are subject to charge, e.g. 0.14 €/min. on the German landline network. Tariffs of other
phone companies may differ.
Additional support
We also offer introductory courses to help you familiarize yourself with SIMOTION.
Please contact your regional training center or our main training center at D-90027
Nuremberg, phone +49 (911) 895 3202.
Information about training courses on offer can be found at:
www.sitrain.com
Overview
Siemens offers a wide spectrum of drives with a graduated range of power ratings.
Of this extensive selection of drives, the SIMOTION Motion Control System supports the
SIMODRIVE 611 universal, SIMOVERT MASTERDRIVES MC and POSMO CA/CD/SI
drives, as well as other drives.
Coupling via PROFIBUS DP enables the drive system and the SIMOTION system to
exchange all of their data over this link.
Requirement
The following software versions are required for the standard functions described in this
documentation:
● SIMOTION SCOUT V4.0 or higher
● SIMOTION Kernel V4.0 or higher
● SIMOTION technology packages V4.0 or higher
Communication
The PROFIBUS DP field bus allows rapid cyclical data exchange between the DP slave
(drive) and the higher-level DP master (SIMOTION hardware platform, such as SIMOTION
C2xx).
Note
The _RWPAR_cyclic function block described in this documentation enables you to read or
write the individual parameters of a drive. In so doing, the parameter channel is transferred
in the cyclic message frame. This requires that the relevant drive supports data exchange via
the parameter identifier value (PIV) interface, as defined in the PROFIdrive V2 Drive Profile
(1997).
For drives that support the parameter channel according to the PROFIdrive V3.1 Drive
Profile (parameter requests are transferred with acyclic DP-V1 message frames), the
corresponding system functions are available in SIMOTION:
• _readDriveParameterDescription: This function enables the descriptive data of a drive
parameter to be read out.
• _readDriveParameter: This function enables a drive parameter to be read.
• _writeDriveParameter: This function enables a drive parameter to be written.
• _readDriveFaults: This function enables the current fault buffer entry in the drive to be
read.
• _readDriveMultiParameterDescription: This function enables multiple parameter
descriptions to be read.
• _readDriveMultiParameter: This function enables multiple parameters to be read.
• _writeDriveMultiParameter: This function enables multiple parameters to be written.
Further information is contained in the SIMOTION C2xx / P350 / D4xx System
Function/Variables lists manual. These documents are shipped with SIMOTION SCOUT in
electronic form!
The SIMODRIVE 611 universal, SIMOVERT MASTERDRIVES, MICROMASTER MM4, and
POSMO CA/CD/SI drives support both the PIV interface as well as the acyclic parameter
channel. SINAMICS devices support only the acyclic PROFIdrive parameter channel.
Requirement
The following requirements must be met:
1. You have created a project in SIMOTION SCOUT and have inserted a rack with a
SIMOTION hardware platform in the hardware configuration.
2. You have configured a PROFIBUS subnet.
3. You have commissioned the drive(s) and inserted them in your SIMOTION project.
4. You have configured the drive(s) as a PROFIBUS slave and have assigned parameters
for the PROFIBUS DP interface.
5. PIV slot
If the message frame set during configuration of the drive as a PROFIBUS slave (HW
Config > DP slave properties > Configuration tab) does not contain a PIV component,
then one PIV slot must be configured for each axis (slot 4 for single-axis drives; slots 4
and 8 for double-axis drives).
Refer to the figure: "Addresses (PIV slot) in SIMOTION SCOUT"
Note:
For SIMOVERT MASTERDRIVES MC, a message frame with a PIV component must be
set.
Note
For instructions on creating a project, configuring a PROFIBUS subnet, and inserting a
drive in the project, refer to the online help for SIMOTION SCOUT.
For additional information, e.g. about commissioning, refer to the user manuals of the
installed drives.
VAR_GLOBAL
...
myInstRWParCyclicAxis1: _RWPAR_cyclic ; // create "_RWPAR_cyclic"
// instance
...
END_VAR
B5:3$5BF\FOLF
(1 (12
$55$<>@RI%<7( SHUL,Q SHUL2XW $55$<>@RI%<7(
%22/ H[HFXWH UHFHLYH3DUD9DOXH ':25'
8,17 SDUD1XPEHU EXV\ %22/
86,17 LQGH[ GRQH %22/
':25' VHQG3DUD9DOXH HUURU %22/
6,17 MRE,GHQWLILFDWLRQ HUURU,' ,17
8,17 VORW1XPEHU
/$'VSHFLILFSDUDPHWHUV
Application example
The application example is included on the "SIMOTION Utilities & Applications" CD-ROM
and is available for various SIMOTION hardware platforms.
The "SIMOTION Utilities & Applications" CD-ROM is provided free of charge and part of the
SIMOTION SCOUT scope of delivery.
Overview
To read and write drive parameters by means of the PIV interface, you must define I/O
variables in SIMOTION SCOUT.
Communication between the SIMOTION device and the drive takes place by means of direct
I/O access when data are exchanged over the PIV interface. I/O variables are used to
address the direct read/write access to the I/O.
You can freely assign the names of I/O variables in SIMOTION SCOUT. I/O variables must
be specified as ARRAY [0..7] of BYTE. You assign addresses set in the hardware
configuration (PIV slot) to these I/O variables.
The names of the I/O inputs must be transferred to the function block as a call parameter
(inputInterface). The data prepared for the I/O outputs are made available as output
parameters by the FB and must be assigned to the corresponding I/O variables (see call
example in the "Calling the Function Block" section).
The following example shows how to assign the module addresses to the I/O variables in
SIMOTION SCOUT.
Input addresses and output addresses have a range of 8 bytes each (corresponding to the
PIV range of the drive).
Note
For additional information, refer to:
• SIMOTION SCOUT online help
• Programming manual of the corresponding programming language, e.g.:
– SIMOTION ST, Structured Text programming manual
– SIMOTION MCC, Motion Control Chart programming manual
– SIMOTION LAD/FBD, Ladder Diagram and Function Block Diagram programming
manual
These documents are shipped with SIMOTION SCOUT in electronic form!
Task
The _RWPAR_cyclic function block enables you to read or write the individual parameters of
a drive.
For this purpose, the relevant drive must support the mechanism of data exchange via the
PIV interface.
B5:3$5BF\FOLF
(1 (12
$55$<>@RI%<7( SHUL,Q SHUL2XW $55$<>@RI%<7(
%22/ H[HFXWH UHFHLYH3DUD9DOXH ':25'
8,17 SDUD1XPEHU EXV\ %22/
86,17 LQGH[ GRQH %22/
':25' VHQG3DUD9DOXH HUURU %22/
6,17 MRE,GHQWLILFDWLRQ HUURU,' ,17
8,17 VORW1XPEHU
/$'VSHFLILFSDUDPHWHUV
_RWPAR_cyclic FB parameters
Note
The SIMOTION identifiers have changed as of V4.0. A comparison of the designations up to
V3.2 / from V4.0 is contained in the "List of parameters" table in Appendix A.
Note
If errorID = 201, an incorrect slot was configured
Remedy: Check and modify slot configuration!
If errorID = 301, transfer of the request was aborted because no correct response data has
been received from the drive after 1000 function block call cycles.
Remedy: Repeat request, check communication link if necessary!
If errorID = 302, parameter change rights do not exist for the relevant drive
Remedy: Set the parameter change rights and repeat the request.
If you want to read and write indexed parameters for SIMODRIVE 611 universal and
SIMODRIVE POSMO CD, CA and SI, you must set bit 11 in the P879 parameter to "1".
For information about drive parameters and their formats and data types, refer to the user
manuals for the installed drives.
Function description
This function block processes the PIV interface (4 words wide) in a cyclic message frame.
A complete request (paraNumber, index, sendParaValue, jobIdentification) is processed.
Consistent data transfer is ensured by the byte ARRAY mechanism for I/O inputs and
outputs. A new request is accepted through a positive edge at the execute parameter of the
block. A busy parameter at the block indicates that request processing is in progress. A new
request cannot be started until processing of the previous request is finished (done = TRUE).
Any errors are indicated in the error and errorID parameters.
H[HFXWH
EXV\
GRQH
HUURU
Note
If you want to read or write parameters from multiple drives, you must create an FB
instance with a new name for each drive.
Call example
UNIT E_rwPar;
INTERFACE (1)
VAR_GLOBAL
myInstRWParCyclicAxis1 : _RWPAR_cyclic; // create "_RWPAR_cyclic" instance
myTransferError : WORD :=16#0000; // displays error number of
// data transfer
myWrOneParaToAxis1 : BOOL :=FALSE; // starts the transmission of
// proportional gain
// (non indexed parameter) to Axis1
END_VAR
PROGRAM ExampleRWParameter;
END_INTERFACE
IMPLEMENTATION
VAR
mySlotNumberAxis1 : UINT ;
myStartParamAxis1 : BOOL :=FALSE; // start flag for data transmission
//of axis 1
myParaNumAxis1 : UINT :=0;
myIndexAxis1 : USINT := 0;
mySendParaValueAxis1 : DWORD :=16#0000;
myJobIdentificationAxis1 : SINT := 0;
END_VAR
END_PROGRAM
END_IMPLEMENTATION
Note
The ExampleRWParameter program must be assigned in the execution system.
Hardware platform
The application example is available for various SIMOTION hardware platforms.
Note
If the application example is not available for your hardware platform, you have to adapt the
hardware configuration.
Note
For commissioning the drive, please observe the drive documentation!
This documentation is included in the SIMOTION SCOUT scope of supply as electronic
documentation!
Table 3-1 Overview of the data structures for the drive parameters
Before initiating the transfer, you can modify the values of the drive parameters to be written
in the symbol browser and activate them using the "Immediate control" button.
Note
If myTransferError = 201, an incorrect slot was configured
Remedy: Check and modify slot configuration!
If myTransferError = 301, transfer of the request was aborted because no correct response
data have been received from the drive after 1,000 function block call cycles.
Remedy: Repeat request, check communication link if necessary!
If myTransferError = 302, parameter change rights do not exist for the relevant drive
Remedy: Set the parameter change rights and repeat the request.
If you want to read and write indexed parameters for SIMODRIVE 611 universal and
SIMODRIVE POSMO CD, CA and SI, you must set bit 11 in the P879 parameter to "1".
For information about drive parameters and their formats and data types, as well as a
detailed description of the error ID, refer the the SIMODRIVE 611 universal (PIV range)
function description.
This documentation is included as electronic documentation with the supplied SIMOTION
SCOUT!
Name in the SIMOTION system as of V4.0 Name in the SIMOTION system up to V3.2
(program library in SCOUT) (SIMOTION function library)
Function block parameters
_RWPAR_cyclic _FB_rwPar_cyclic
periIn inputInterface
execute execute
paraNumber parameterNumber
index index
sendParaValue sendParameterValue
jobIdentification jobIdentification
slotNumber slotNumber
periOut outputInterface
receiveParaValue receiveParameterValue
busy busy
done done
error error
errorID errorID
_ S
_RWPAR_cyclic function block, 16 Start-up and Parameterization of PROFIBUS DP
Interface, 11
C
Call example for reading and writing, 20
Calling the function block, 19
Creating I/O variables, 13
E
Example of an application, 21
F
FB _RWPAR_cyclic parameters, 16
Function block
Call, 19
Parameter, 16
Task integration, 18
Function blocks, 15
G
General, 9
I
Integrating the function block, 12
L
List of parameters, 25
R
References, 3