User manual

Toolbox 32 User Manual 1.47d www.cse-semaphore.com/mykingfisher
Page
89
Call
Calls a function defined in the ladder. As used in the topic Example – Time Based Rolling Averages.
Call Function: The name of the function block to call. This name must be entered exactly as it appears in
the corresponding Start Function block (it is case sensitive). To be used as an input, the function block called
must have a return variable of Boolean. To be used as an output, the function block called must have a
return variable of None.
Variables: A list of all variables (registers, constants, etc) to be passed to the function block. Eg. the above
call function passes pump 1 parameters to the Pump Fault function. Pump Fault then returns True or False.
Note: Ladder logic processing is transferred to the specified function block, until a Return from Function
Block is encountered. Ladder then continues being processed from after the function block call.
Note: DNP3 function blocks are available from www.cse-semaphore.com/mykingfisher.
Start Function Block
Defines the start of a function block. It must be located on its own ladder rung above the function block
ladder logic that it denotes the start of. As used in the topic Example – Time Based Rolling Averages.
Function Name: The name of the function block. This is a 12-character case-sensitive name that can
include spaces.
Variables: (Optional) A function block can be passed up to 32 variables when it is called using the Call
function block. The data type of each variable passed must be defined here as Boolean (bit), Integer (16-bit
register), Float or Long. Each variable can be assigned a 15-character label that can include spaces and
other ASCII characters. This label is then displayed as a comment alongside each variable when the function
block is called using a Call function block.
Return Variable Type: None or Boolean (True or False). If defined as None, it is an input function. If defined
as Boolean it is an output function.
Return
Transfers ladder logic processing back to the next block after the Call Function Block. If the Return block is
used with an output function, the return value must be none; if the Return block is used with an input
function, the return value must be True or False. As used in the topic Example – Time Based Rolling
Averages.
Return Value: (None, True or False) The result returned by the function.
Jump
Jump to label Label1. Can jump forwards and backwards. Labels are defined in the comment field of the first
block on the rung and must have the format: LabelName: ie. the label name followed by a colon. Labels
cannot be defined in a Comment Field block. As used in the topic
Example – Time Based Rolling Averages.