25.1
Built-in DOP functions
Description of the parameters common to the different DOP functions
Introduction
Subject of this section
This section shows the main parameters, divided into zones, of the built-in
DOP functions.
Note: The parameters specific to a DOP function are shown at the level of the function concerned.
What's in this
Section?
This section contains the following topics:
Topic
General
Parameters field: Console address
Parameters field: Data to be sent
Parameters field: Data to be received:
Parameters field: Report
Message field
Field zone
Page
368
369
372
374
375
379
381
35012326 00 July 2006
367
Built-in DOP functions
General
Introduction
Illustration
The Built-in DOP functions are part of the procedure category; they do not return value, but they do possess several parameters, some of which have to be filled in.
The functions use three types of parameters: z z in read only (IN) format, acknowledged at the start of function execution, in write only (OUT) format, set at close of function execution, z in read and write format (IN/OUT), whose contents have been acknowledged at the start of function execution and are then updated by the function results.
The parameter type is displayed in the Type of Parameter of the … column located in the Library functions screen.
The illustration below gives an insight into the Library functions screen where the various parameters of the selected function are displayed.
PL7: Library functions
EF
Function information: Parameters Detail...
Family Lib.V.
App.V
Dates, Times, and Periods2.10 -
Diagnostics
Integrated DOP
Explicit exchanges
1.01 -
3.03 3.03
1.00
Name
ADJUST
ASK_MSG
ASK_VALUE
ASSIGN_K
Call format
PROCEDURE parameter:
Name Type
ADR AR_W
DATA AR_W
VAL AR_W
Kind
IN
Comment
CCX17 address table
IN Table for data to be sent
OUT Table for data to be received
Comment
Read/write memory objects and I/O
Variable blocking entry on CCX
Variable blocking entry on >>
Dynamic key assignment >>
Entry field
?
Call display
ASK_MSG( )
OK Cancel
368 35012326 00 July 2006
Built-in DOP functions
Parameters field: Console address
Introduction
Addressing via words or constants
This parameter contains the access path (address) for the CCX 17 dialog console.
This path can be either: z z located in a table of six internal words (%MW), located in a table of six internal constants (%KW), z or passed directly to an immediate value in the form of an ADR# operator.
ADR# is then assimilated into a table of six consecutive internal words.
The table below shows the signification of different words which make up the console address.
Word number
%MWi / %KWi
%MWi +1 / %KWi+1
%MWi +2 / %KWi+2
%MWi +3 / %KWi+3
%MWi +4 / %KWi+4
%MWi +5 / %KWi+5
Description
0
0
Most significant
6 (Uni-telway)
7 (FIPIO
254 (1)
Rack number
CCX 17 address
SYS
FIPIO connection point
Least significant
0
0 (1)
Module number channel
SYS (FIPIO)
0
Key
(1) Operating a CCX 17 console means that only one intra-station address is authorized. As a result, the {Station.Network} pair systematically takes on the value {0.254}.
Writing this field is optional.
Note: The key word SYS (value 254) corresponds to attributing an address to the system channel (UNI-TE server) for a communication channel.
35012326 00 July 2006
369
Built-in DOP functions
Uni-telway addressing
The format of a CCX 17 address connected to the Uni-telway bus is:
ADR#{<Network>.<Station>}<rack.module>.<channel>.<CCX 17 address> ,
ADR#{<Network>.<Station>}< rack.module>.<channel>.SYS
,
ADR#< rack.module>.<channel>.<CCX 17 address> ,
ADR#< rack.module>.<channel>. SYS.
FIPIO addressing The format of a CCX 17 address connected to the FIPIO bus is:
ADR#{<Network>.<Station>}<rack.module>.<channel>.<connection point>\SYS ,
ADR#< rack.module>.<channel>.<connection point>\SYS .
370 35012326 00 July 2006
Built-in DOP functions
Examples of addressing
If you use: internal (or constant) words
ADR syntax
If you use: internal (or constant) words
ADR syntax
-
For a CCX 17 slave on a UTW 4-5 address, connected to a Premium PLC via the built-in Uni-telway link (channel 0) positioned in rack 0.
Addresses can be entered in many ways (example here using internal words %MW0 to %MW5): in the function entry Help screen, …
Example:
Parameters
Console address: %MW0
Example:
Parameters
Console address: ADR#0.0.4
6 you must enter the program…
-
%MW0:=16#0600;
%MW1:=16#FE00;
%MW2:=16#0000;
%MW3:=16#0400;
%MW4:=16#0000;
%MW5:=16#0000; or
%MW0:6:=ADR#0.0.4;
DOP_Function(ADR#0.0.4,...
For a slave CCX 17 connected to a Premium master PLC via the built-in FIPIO link (channel 1) positioned in rack 0 (connection point no. 7).
Addresses can be entered in many ways (example here using constant words
%KW0 to %KW5): in the function entry Help screen…
Example:
Parameters
Console address: %KW0
Example:
Parameters
Console address: ADR#\0.1.7\SYS
6 you must enter the program…
-
%KW0:=16#0700;
%KW1:=16#FE00;
%KW2:=16#0000;
%KW3:=16#0701;
%KW4:=16#00FE;
%KW5:=16#0000; or
%KW0:6:=ADR#\0.1.7\SYS,...;
DOP_Function(ADR#\0.1.7\SYS,
...
Note: If using constants, the %KW0:6 table must be initialized beforehand using the Data editor by successively assigning the %KWi which make up the table.
35012326 00 July 2006
371
Built-in DOP functions
Parameters field: Data to be sent
Introduction
Locating items within the PLC application
Data to be sent is individual to each type of MMI function.
The data can be found either in the PLC application, or in the CCX 17 when it has its own application.
In the case where data is to be found in the PLC application, it can be sent from: z a table of internal words (%MW), z a table of internal constants (%KW).
The table below shows the structure of data sent in this way.
Role Word number
1
2
3
4, 5, ...
Contains a contains a marker for value 16#CC17, and has a double role: z it allows the Help screen to identify a correct message and to redisplay the values on the entry screen in order to help modify or display default values.
z it allows the function being carried out to check that the table received does actually contain a message for a CCX 17. In fact, it is possible to call an
Integrated DOP function in a program without going via the Help/Control screens.
In the case of an unmarked message, the function can immediately return an error back to the application without sending unreliable data to the console.
Contains the command number.
Contains the length of data to be sent.
Contains the data to be sent.
Note: For reasons of efficiency, the <Data to be sent> parameter can be programmed using %KWi constants. In this way the software automatically initializes this data field with adequate values.
Selecting %MW bars access to different fields in the entry help box for integrated
DOP functions. It is then necessary to establish, either manually or by program, the contents of the data to be sent (see PL7 MMI 17 software documentation).
372 35012326 00 July 2006
Location in a
CCX 17 with application
Built-in DOP functions
When data is in a CCX 17, the data to be sent is limited to DOP function execution commands.
This data can be sent from the PLC application: z from a table of internal words (%MW), z from a table of internal constants (%KW), z directly using an immediate integer value.
The table above shows data structure when using a table.
Role
1
2
Word number
Contains a command number
Contains the data to be sent to the console.
35012326 00 July 2006
373
Built-in DOP functions
Parameters field: Data to be received:
Introduction This parameter only affects functions ASK_MSG and ASK_VALUE .
The data is located in an %MWi internal word table (length 2 table maximum).
Note: By operating the MMI console, the Data to be received parameter contains the value entered. If the status message variable is different from the data to be received, it is not changed by the entry. It only affects the display on the CCX 17.
374 35012326 00 July 2006
Built-in DOP functions
Parameters field: Report
Introduction The report contains the parameters for managing asynchronous communication functions.
It is common to all integrated DOP functions.
Report structure The report uses a table of four internal words (%MW) containing different parameters such as: z z information on function activity, the exchange number which identifies the transaction in progress (useful when z z z using the CANCEL communication function), the exchange report split into two feedback codes: z z the communication level, the operation level, the value of the timeout which is used to monitor absent responses, the number of bytes to be sent and/or the number of bytes received.
The table below show the structure of the report.
Word number Most significant byte
%MWi Exchange number
%MWi+1
%MWi+2
%MWi+3
Operation report
Timeout
Length
Least significant byte Report management
Bit 0: activity bit System
Communication report System
User
System
%MWi:X0 activity bit
This bit indicates the state of the application of the communication function.
It is set on 1 when the function starts and falls back to 0 when a response is received, at the end of a timeout, or if the operation is cancelled (CANCEL function).
Exchange number
While a function is being sent, the system automatically assigns it a number which is used to identify the exchange.
This number serves as a reference to stop the exchange in progress, if necessary
(on using CANCEL).
35012326 00 July 2006
375
Built-in DOP functions
Communication report
The communication report provides information on the communication aspect of the transaction.
This report is significant when the value of the activity bit changes from 1 to 0.
Note: The communication report does not affect the ADJUST function.
16#0005
16#xx06
16#0007
16#0008
16#0009
16#000A
16#000B
16#xx14
16#00FF
The different values of this report are indicated in the following table:
Value
16#xx00
16#0001
16#0002
16#0003
16#0004
Significance of the communication report (least significant byte)
Successful exchange
Stopping the exchange via a timeout
Stopping the exchange on user request (CANCEL function)
Incorrect address format (length is other than 6)
Incorrect destination address (addresses unauthorized for the CCX 17, e.g.: addresses being broadcast)
Invalid report
Specific parameters are invalid (particularly those concerning data to be sent)
Destination missing
Reserved
Size of reception buffer is insufficient
Size of transmission buffer is insufficient
System resources missing (communication saturation)
Negative response from the CCX 17 or from the PLC (ADJUST function)
Message refused (the CCX 17 is not in a state where it can process it)
Note: The function can detect an error in the parameters before activating the exchange. In this case the activity bit remains 0, the report is initialized with the values corresponding to the fault.
376 35012326 00 July 2006
Built-in DOP functions
Operation report The operation report details the result of the operation on the remote application.
It is significant if the communication report has the following values: z z
16#00,
16#06, z
16#14 (except for the ADJUST function).
In other cases, the operation report is worth 0.
The different values of this report are indicated in the following table:
Communication report
(least significant byte)
16#0000
16#1006
16#1106
16#1206
16#1306
16#1406
16#6506
16#6606
16#6706
16#6806
16#6906
16#FF06
16#0114
16#0214
16#0414
16#0814
16#1414
16#1514
16#2014
Significance of the operation report
Generic positive result
Number of management words below 24
Non-existent type object to be read (greater than 8)
Inconsistency between bits RDEC and SINC
Invalid value to be written
Broadcast address (ALL) prohibited
{network.station} pair different from {0.254}
Data to be sent does not have a 16#CC17 marker
Invalid size of data to be sent
Invalid CCX 17 response
Length of "Data to be received" is insufficient
CCX 17 link inoperational
Command not recognized
Command queue capacity has been exceeded
Size of command is less that the minimum required size
Command refused because application transfer in progress
Inaccessible object
System error
Incorrect data
Integrated DOP functions
All
ADJUST only
All except ADJUST
ADJUST only
All except ADJUST
35012326 00 July 2006
377
Built-in DOP functions
Timeout Timeout determines the maximum waiting time for a response. The time base for this parameter is 100 ms.
value 0 corresponds to an infinite wait value. In this case, the CANCEL function should be used.
Note: Value 0 is mandatory for functions ASK_MSG and ASK_VALUE .
If the timeout period has elapsed, the exchange terminates with an error report
(value 1). Similarly, the system refuses any response received at the end of the timeout.
Example
Start function
End of timeout
Activity bit = 0
Report = 1
Activity bit = 1
Timeout activation
Report set to zero
Allocation of exchange number
Receive response
Activity bit = 0
Stop timeout
Report update
Length
Note: The timeout value of a communication function must be sufficient to guarantee receiving a response to the question asked. This time period depends on the type of network and on the load in effect at the moment of the transaction.
The length parameter is used to store the number of bytes received after receiving a message for functions ASK_MSG and ASK_VALUE.
For the other functions, this parameter is worth 0.
378 35012326 00 July 2006
Built-in DOP functions
Message field
Introduction
Message text
The message field groups together the different elements that make up the data to be displayed on the CCX 17 screen.
These elements are: z the message text, z z the different display attributes (position, size, etc.).
the message print command via the CCX 17.
This field is used to enter the message text that is to be displayed on the CCX 17 console.
The length of the message is 40 characters max.
The table below details the types of characters authorized.
Characters Comments
ASCII code above 32 (20h) Characters that can be displayed directly or by a combination of the and keys.
The _ sign (underscore) This character is reserved by the system to specify the optional display field for the variable associated with the message.
To specify the position of the variable field, the character must be entered in the appropriate place. The system then automatically calculates the number of necessary for the length of the variable display.
Print
Overprint
Line
This parameter orders the command console to print a message when it appears on the console screen.
This parameter refers to alarm messages only. Enabling this parameter overprints the alarm message as soon as it appears.
This parameter specifies the line where the message must be displayed.
Position
Minimum
Default
Maximum
Value
1
1
16
35012326 00 July 2006
379
Built-in DOP functions
Column This parameter specifies the column where the first message character is positioned.
Position
Minimum
Default
Maximum
Automatic (1)
Value(s)
1
1
40
Left, Centered, Right
Key
(1) This mode can be accessed by selecting automatic mode. It is local to the function.
Attributes
Size
Clear
This parameter sets the attributes of the message display.
The different modes are: z z z
Normal (when no check box has been selected),
Flashing,
Reverse video.
This parameter specifies the format of all the text characters or the variable to be displayed.
Possible options are: z
Standard, z
Double.
This field is used to associate a single command that has been executed with a message before the message has been displayed.
Options are: z
None (no command is associated with a message), z z
Line (clears the line on which the message is to be displayed),
Screen (completely clears the screen).
Note: If no variable has been associated with a message, this command does not run (so use the PANEL_CMD function).
380 35012326 00 July 2006
Built-in DOP functions
Field zone
Introduction
Field type
Symbol
Address
Comment
The Field zone is used to set the different parameters for the object which is associated with a message.
These parameters are: z the type of object, z z the display format,
...
This parameter sets the type of object which is associated with a message.
The length of the message is 40 characters max.
The table below shows the different object types possible.
Type of object
None
Address
Date
Time
Description
No field is associated with the message displayed.
The object associated with the message is a variable.
The message is correlated to the current PLC date.
The message is correlated to the current PLC time.
This parameter specifies the symbol of the variable associated with the message. It must be set in the station database. The address associated with this symbol is automatically taken into account on confirming the screen.
Note: In the case of a TSX Agent connected to the FIPIO bus, the variable is read in the bus master PLC, and not in the function sender PLC.
This parameter specifies the address of the variable associated with the message.
When a symbol is associated with the variable, it is automatically taken into account.
Authorized objects can be: z z z internal bits (%Mi), internal words (%MWi), double internal words (%MDi).
This field displays the variable comment for viewing. This comment is set in the application data editor.
35012326 00 July 2006
381
Built-in DOP functions
Refresh
Display format
This function specifies whether the variable contained in the message should be periodically refreshed while being displayed (function is active be default).
This parameter specifies the variable display format.
The table below shows the different formats available.
Format
ASCII
Numerical
-
Associated parameters
Signed (1)
Number of digits before the decimal point (1),
Number of digits after the decimal point (1),
Key
(1) these associated parameters can be accessed by clicking on the Modify button.
Note: From the parameters chosen, the software automatically calculates the display format.
382 35012326 00 July 2006
