CommandablePoint (FB)

FUNCTION_BLOCK ABSTRACT CommandablePoint EXTENDS PointWithFlags IMPLEMENTS ICommandablePoint

Base object for all DNP3 datapoints which are commandable

InOut:

Scope

Name

Type

Initial

Comment

Inherited from

Input

Description

STRING

Description of the datapoint - this is a configuration, changes are ignored after Outstation was enabled.

Point

Number

DINT

-1

Point number - this is a configuration, changes are ignored after Outstation was enabled.. The point number can be configured if needed to either:

  • start with Point number > 0

  • have gaps in Point numbers

If set to -1 (the default) the OutstationDataModel (more precisely the related “Group”) takes care to set the Point number internally:

  • starting at 0, if first Point number is not set explicitly.

  • increment by 1

In case you set Point number explicitly please keep it consistent:

  • Point numbers need to be >= 0

  • Point numbers need to be ascending

Point

EventClass

USINT

Constants.TMWDEFS_CLASS_MASK_ONE

The initial event class - this is a configuration, changes are ignored after Outstation was enabled. Operational event class may be changed by a master.

Point

EventMode

PointEventMode

PointEventMode.EVENT_MODE_SOE

The event mode - this is a configuration, changes are ignored after Outstation was enabled. Only used if the sampling rate is set within the outstation configuration.

Point

tScanPeriod

TIME

TIME#0ms

Scan period for datapoint. If tScanPeriod is set to T#0MS, the Group related tScanPeriod or the OutstationDataModel.tScanPeriod is used.

Point

udiLogOptions

UDINT

OutstationLoggingOptions.None

LoggingOptions can be combined using OR.

Point

Output

xError

BOOL

An error occured.

Point

eErrorID

Error

The specific error.

Point

Input

flags

BYTE

Constants.DNPDEFS_DBAS_FLAG_ON_LINE

Flags used by the point. Can be changed in case a point goes offline or any other error. If set to 0, the variation without flags will be used by DNP3

PointWithFlags

EnableCommand

BOOL

FALSE

Enable / disable commanding (from DNP3 master) - this is a configuration, changes are ignored after Outstation was enabled.

CmdEventClass

USINT

Constants.TMWDEFS_CLASS_MASK_ONE

The initial command event class - this is a configuration, changes are ignored after Outstation was enabled. Operational command event class may be changed by a master.

CmdEventMode

PointEventMode

PointEventMode.EVENT_MODE_SOE

The command event mode - this is a configuration, changes are ignored after Outstation was enabled. Only used if the sampling rate is set within the outstation configuration.

rejectCommand

BOOL

FALSE

Reject master commands, only relevant, if EnableCommand is set to TRUE.

eCommandRejectReason

CommandRejectReason

CommandRejectReason.Local

Let the master know, for which reason a command was rejected (xEnableCommand = FALSE).

resetCommand

BOOL

FALSE

Reset an active master command and use local command value again at rising edge (FALSE –> TRUE). At / after reset, the local command value is used as a resultingValue until next master command.

Output

commandActive

BOOL

A master command was accepted and is active right now. The command value issued with the master command is used as a resultingValue until a command reset happens - see resetCommand.

Properties:

PointNum, inherited from Point

PointTyp, inherited from Point

Methods:

Structure: