TagWriteValueQualityFB Function Block

Help Contents

Introduction

The TagWriteValueQualityFB Function Block writes a value and quality to an Internal Data Point Tag.

The function block writes the value and quality by sending a WriteValueQuality Tag Command to the tag. The function block provides status information to:

Functions and Function Blocks

The TagWriteValueQualityFB 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. The function block samples the state of the tag command as it executes.

To write a value and quality from an Operator Action, use the TagWriteValueQuality Function.

Syntax

The TagWriteValueQualityFB Function Block has this syntax:

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

Note: All parameters are optional.

Parameters

The TagWriteValueQualityFB Function Block has these parameters:

Parameter Type Direction Description
REQ BOOL R_EDGE Input A rising edge starts the WriteValueQuality Tag Command.
TAGNAME STRING Input The name of the tag to send the WriteValueQuality Tag Command to. For more information see TAGNAME Parameter in the remarks section.
VALUE ANY Input The value to write to the tag.
QUALITY INT Input The quality to write to the tag.
BUSY BOOL Output Set to TRUE while the WriteValueQuality Tag Command is in progress.
DONE BOOL Output Set to TRUE for 1 execution after the WriteValueQuality Tag Command has completed.
ERROR BOOL Output Set to TRUE if the WriteValueQuality Tag Command failed.
ERRORMSG WSTRING Output If ERROR is TRUE, the reason why the WriteValueQuality Tag Command failed.

Remarks

TAGNAME Parameter

The TAGNAME parameter is the full name of the tag that runs the WriteValueQuality Tag Command. The value of this parameter can be an absolute tag name or a relative tag name. A relative name tag name is resolved relative to the program tag that runs the function block.

The tag should be one of the types listed in the Applies To list of the WriteValueQuality Tag Command.

Timing Diagram

Once the WriteValueQuality Tag 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.

Debug a Function Block

To monitor the state of a function block as it executes:

  1. Open the program in the Configuration Tool.
  2. Right click the program editor and select Watch Global Variables.
  3. Expand the variables on the left until the function block member variables are visible.

Use the ERROR and ERRORMSG member variables to check the tag command is executed correctly.

Further Information

WriteValueQuality Tag Command

To learn about the WriteValueQuality 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.