TagDirectWriteWord Function Block

Introduction

The TagDirectWriteWord Function Block writes one or more words to an an address in a data source associated with a tag.

The function block writes the data words by sending a DirectWriteWord tag command to the tag. The function block provides status information to:

Monitor the progress of the tag command.
Report whether the tag command succeeded or failed.

Functions and Function Blocks

The TagDirectWriteWord Function Block is intended for use in a Program Tag that runs on the Fernhill SCADA Server. A Program Tag uses a continuous execution model, where the program code runs at a fixed interval. A program uses the function block to sample the state of the tag command as it executes.

There is no equivalent TagDirectWriteWord Function for use in an Operator Action.

Syntax

The TagDirectWriteWord Function Block has this syntax:

TagDirectWriteWord(
        REQ:=Expression,
        TAGNAME:=Expression,
        DATAADDRESS:=Expression,
        VALUE:=Variable-Reference,
        BUSY=>Variable-Reference,
        DONE=>Variable-Reference,
        ERROR=>Variable-Reference,
        ERRORMSG=>Variable-Reference );

Note: All parameters are optional.

Parameters

The TagDirectWriteWord Function Block has these parameters:

Parameter	Type	Direction	Description
REQ	BOOL R_EDGE	Input	A rising edge starts the DirectWriteWord Tag Command.
TAGNAME	WSTRING	Input	The name of the tag to send the DirectWriteWord Tag Command to.
DATAADDRESS	WSTRING	Input	The data address within the data source.
VALUE	ARRAY [] OF WORD	Input	The words to write to the data source.
BUSY	BOOL	Output	Set to TRUE while the DirectWriteWord Tag Command is in progress.
DONE	BOOL	Output	Set to TRUE for 1 execution after the DirectWriteWord Tag Command has completed.
ERROR	BOOL	Output	Set to TRUE if the DirectWriteWord Tag Command failed.
ERRORMSG	WSTRING	Output	If ERROR is TRUE, the reason why the DirectWriteWord Tag Command failed.

Remarks

Once the DirectWriteWord command begins, additional requests from the input signal REQ are ignored until the tag command completes.

These timing diagrams show the relationship of the REQ, BUSY, DONE, and ERROR signals processing two requests. The first request completes with an error, the second request completes normally:

        +--------+     +-+ +------+
  REQ   |        |     | | |      |
      --+        +-----+ +-+      +------

        +------+       +------+
 BUSY   |      |       |      |
      --+      +-------+      +----------

               ++             ++
 DONE          ||             ||
      ---------++-------------++---------

               +-------+
ERROR          |       |
      ---------+       +-----------------

The BUSY signal is TRUE while the tag command is in progress. The DONE signal is TRUE for 1 execution after the completion of the tag command.

Example Program

The following IEC 61131-3 Program shows:

A FALSE to TRUE transition of a digital data point tag used to trigger a function block.
The function block writing a block of words to an address in a PLC.
Example logic to check the status of the function block.

Program MAIN
    VAR 
        (* The function block declaration *)
        WriteWordFB : TagDirectWriteWord;

        (* The tag used to trigger the write operation
           Note: Uses a relative tag reference to 'Digital Trigger Tag' 
                 located in the same folder as this program *)
        TriggerTag AT %".Digital Trigger Tag" : BOOL;

        (* The data to write *)
        Data : ARRAY [0..5] OF WORD := [100,200,300,400,500,600];
    END_VAR

    (* Call the TagDirectWriteWord function block 
       Note: Using Modbus PLC addressing to write a sequence of bytes to 
             holding registers 101 to 106 *)
    WriteWordFB( 
        REQ:=TriggerTag,
        TAGNAME:="Modbus PLC Tag",
        DATAADDRESS:="400101",
        VALUE:=DATA );

    (* The DONE output is active for one cycle when the function block completes *)
    IF WriteWordFB.DONE THEN

        (* Was there an error ? *)
        IF WriteWordFB.ERROR THEN
            (* Handle any error *)
        ELSE
            (* Any additional work on successful completion *)
        END_IF;
    END_IF;

END_PROGRAM

Further Information

DirectWriteWord Tag Command

To learn about the DirectWriteWord Tag Command.

Tag Command Function Blocks

To learn about other tag command function blocks.

IEC 61131-3 Expressions

To learn about the different types of expression to use as function parameters.

Elementary Data Types

To learn about the different types supported by Fernhill SCADA.

Common Elements

To learn about other IEC 61131-3 Common Elements.

Glossary

For the meaning of terms used in Fernhill SCADA.