Class NodeLinkSup
Version 1.0
Modified 08-MAR-2026 11:05:32.00
 Supervises a link to another node.

 A NodeLinkSup subscribes to a remote $Node objekt, and checks
 the arrival of the subscribed value. If a new value hasn't arrived
 whithin the TimeoutTime an alarm message is sent.

 The NodeLinkSup objects are handled by the rt_linksup server process.

RtBody attributes pwr_sClass_NodeLinkSup
Objid Node   The $Node object on the remote node. Specify the node object
with volume and path, e.g. 'RemoteVolume:Nodes-ProcNode'.

Note! If the node is mounted, it is easy to mix up the MountObject with
the remote $Node object. Be sure to specify the remote $Node object.
UInt32 TimeoutTime   Timout time in seconds.
If a subscription value has not arrive whithin the timeout time,
an alarm message is sent.
Float32 SubscriptionInterval   Subscription interval in seconds.
Boolean LinkUp   Indicates that the link is up.
LinkUp is true if the link is up, and false if the link is down.
Time UpTime   The last time the link was established.
Time DownTime   The last time the link was lost.
UInt32 UpCount   Number of link up events.
RefId SubId   Subid for the subscription.
Boolean Control con Specifies whether to enable or disable the supervision.
Note that blocking is done when Control is FALSE. The
input signal can be inverted.

FALSE disables the supervision and TRUE or open input
enables the supervision.
Boolean Action act Specifies the status of supervised quantity. FALSE
means normal state and TRUE means alarm state.
The output signal can for instance be used to activate
an action sequence at alarm state.
Boolean Acked ack Specifies the status of supervised quantity. FALSE
means normal state and TRUE means alarm state.
The output signal can for instance be used to activate
an action sequence at alarm state.
Boolean Blocked blk Specifies whether to enable or disable the blocking. No
messages from the supervision object will be sent away
as long as the object is blocked. The blocking does not
influence on the 'act' output of the object.

FALSE disables the the blocking and TRUE enables the
blocking. When a supervisory object in alarm position
is blocked current messages will be cancelled.
Blocking /deblocking is done by means of the 'Alarm
Blocking Window' in the operator environment.
String104 Description   Optional text to describe the object. It is used in the
picture Alarm Limits which is activated from the
operator window.
Boolean DetectOn   Specifies whether to enable or disable the action,
which at alarm state implies DetectText to be sent or
not. FALSE means that no message will be sent at alarm
state; TRUE means that DetectText is sent at alarm
state.
String80 DetectText   Alarm message. Optional text which will be written out
at alarm state if DetectOn is TRUE.
String80 ReturnText   Return message. Text which will be written in the event
list at return to normal state.
UInt32 EventType   Specifies the type of the message (=DetectText ) which
will be sent at alarm state.
ALARM -- 64 The message always requires an
acknowledgement and sent to the alarm

INFO -- 32 If the message requires acknowledgement is
it sent to the info part of the alarm
window and the event list, otherwise only
UInt32 EventPriority   Priorities concerning alarm messages.

-- 67 A-alarm; highest priority. (=43Hex)
-- 66 B-alarm (= 42Hex)
-- 65 C-alarm (= 41Hex)
-- 64 D-alarm ; lowest priority. (=40Hex)
UInt32 EventFlags   Bit map. A flag combination may be attached to the
message:

1 = If this flag exists the return message
ReturnText will be sent to the event lists of

2 = If this flag exists the acknowledgement message
will be sent to the event lists of the out

4 = If the out unit has a peep-function this will
be activated when the message is received.

8 = The message is sent to every out unit

16 = If the message is of the type INFO it will be
placed in the event list. If this flag exists
the message is also placed in the INFO square
of the alarm window where acknowledgement is to
AttrRef Sound   Reference to a sound object, that defines the sound at the operator
place when the alarm is active. If no sound object is supplied, an
ordinary beep is used. The sound object should be of class Sound
or SoundSequence
Text256 MoreText   Optional text supplying more information about the event.
The more text can for example contain actions to be made when an alarm is detected.
String40 Recipient   Recipient for epost and mms alarms.
The recipient is a user defined in the user database in the
current system group.
Recipient can also be a list of users separated by comma, eg
'dennis, jimmy'. Also symbols defined in the Symbol table in
the PostConfig object can be used. Symbols should be referenced
with a $ sign before the symbol name, eg '$on_duty'.

The users should be defined in the current system group or in a
subgroup to this, If a subgroup is used, the subgroup should
be specified in the recipient name, eg 'sms.dennis'.
AttrRef Attribute   Attribute is filled in by the server process to the
NodeLinkSup object itself.
UInt32 AlarmStatus   Status value. Bit map containing 16 bits where the 8
least significant bits denote the state and the 8 most
significant bits the priority.
The state is a combination of:

-- 0 Normal state
-- 1 Alarm state
-- 2 Unacknowledged alarm
The priority is one of the priorities EventPriority.

The following status can exist:
EventPriority + 1 => Priority + alarm state
EventPriority + 3 => Priority + unacknowledged alarm
and alarm state
Boolean AlarmCheck   Used internal at the event detection.
Boolean DetectCheck   Specifies if an alarm state will be detected or not.
FALSE means that an alarm state will not be detected;
TRUE means that an alarm state will be detected.
Boolean DetectSend   Specifies if the message has already been sent to the
out units (or more precisely the message handler) or
not. TRUE means that the message has been sent.
Time DetectTime   Date and time when alarm state was detected.
Boolean ReturnCheck   Specifies if the object has returned to normal state or
not. TRUE means that the object has returned to normal
state.
Boolean ReturnSend   Specifies if the return message, ReturnText, has been
sent to the out units or not. TRUE means that the
return message has been sent.
Time ReturnTime   Date and time when the last return to normal was
detected.
Time AckTime   Date and time when the last acknowledgement of normal
state was detected.
Objid AckOutunit   Identity of the out unit (operator) which made an
acknowledgement.
Boolean TimerFlag   Indicates an active timer.
Pointer to Boolean TimerNext   Points to the next element in the timer queue.
UInt32 TimerCount   Number of remaining ticks.
Pointer to Boolean TimerDO  
Float32 TimerTime   Delay in seconds. Specifies when, since an alarm state
has occurred, the message will be sent. If the alarm
state disappears before the time has elapsed no message
is generated.
TimerTime >= the executing period of the PLC program.
Boolean TimerDODum  
Objid TimerObjDId   Identity of this object is set at load file creation.
Used by the run time system.
Int32 TimerAcc   The operator's authorities to change TimerTime. Not
implemented.

0 -- Changes not allowed.
!=0 -- Changes allowed.
Float32 TimerMin   Specifies a valid interval at changes made by the
operator on TimerTime.

TimerMin <= TimerTime <= TimerMax
Float32 TimerMax  
Status SystemStatus   Contains the system status of the supervised node.
If the link is down, the status is PWR__NETTIMEOUT.


Template Object
TimeoutTime 20
SubscriptionInterval 1.0
Control 1
EventType 64
EventPriority 67
EventFlags 7
DetectOn 1
DetectText Lost contact with node XXX
ReturnText Established contact with node XXX


Attributes detail


Node Attribute
Class Attribute
Type Objid
Flags
Body RtBody
 The $Node object on the remote node. Specify the node object
 with volume and path, e.g. 'RemoteVolume:Nodes-ProcNode'.

 Note! If the node is mounted, it is easy to mix up the MountObject with
 the remote $Node object. Be sure to specify the remote $Node object.

TimeoutTime Attribute
Class Attribute
Type UInt32
Flags
Body RtBody
 Timout time in seconds.
 If a subscription value has not arrive whithin the timeout time,
 an alarm message is sent.

SubscriptionInterval Attribute
Class Attribute
Type Float32
Flags
Body RtBody
 Subscription interval in seconds.

LinkUp Attribute
Class Attribute
Type Boolean
Flags STATE | NOEDIT
Body RtBody
 Indicates that the link is up.
 LinkUp is true if the link is up, and false if the link is down.

UpTime Attribute
Class Attribute
Type Time
Flags STATE | INVISIBLE
Body RtBody
 The last time the link was established.

DownTime Attribute
Class Attribute
Type Time
Flags STATE | INVISIBLE
Body RtBody
 The last time the link was lost.

UpCount Attribute
Class Attribute
Type UInt32
Flags STATE | INVISIBLE
Body RtBody
 Number of link up events.

SubId Attribute
Class Attribute
Type RefId
Flags STATE | INVISIBLE
Body RtBody
 Subid for the subscription.

Control Input
Class Input
Type Boolean
Flags STATE | INVISIBLE
GraphName con
Body RtBody
 Specifies whether to enable or disable the supervision.
 Note that blocking is done when Control is FALSE. The
 input signal can be inverted.

 FALSE disables the supervision and TRUE or open input
 enables the supervision.

Action Output
Class Output
Type Boolean
Flags STATE | NOEDIT
GraphName act
Body RtBody
 Specifies the status of supervised quantity. FALSE
 means normal state and TRUE means alarm state.
 The output signal can for instance be used to activate
 an action sequence at alarm state.

Acked Output
Class Output
Type Boolean
Flags STATE | NOEDIT
GraphName ack
Body RtBody
 Specifies the status of supervised quantity. FALSE
 means normal state and TRUE means alarm state.
 The output signal can for instance be used to activate
 an action sequence at alarm state.

Blocked Output
Class Output
Type Boolean
Flags STATE | NOEDIT
GraphName blk
Body RtBody
 Specifies whether to enable or disable the blocking. No
 messages from the supervision object will be sent away
 as long as the object is blocked. The blocking does not
 influence on the 'act' output of the object.

 FALSE disables the the blocking and TRUE enables the
 blocking. When a supervisory object in alarm position
 is blocked current messages will be cancelled.
 Blocking /deblocking is done by means of the 'Alarm
 Blocking Window' in the operator environment.

Description Attribute
Class Attribute
Type String104
Flags
Body RtBody
 Optional text to describe the object. It is used in the
 picture Alarm Limits which is activated from the
 operator window.

DetectOn Attribute
Class Attribute
Type Boolean
Flags
Body RtBody
 Specifies whether to enable or disable the action,
 which at alarm state implies DetectText to be sent or
 not. FALSE means that no message will be sent at alarm
 state; TRUE means that DetectText is sent at alarm
 state.

DetectText Intern
Class Intern
Type String80
Flags
Body RtBody
 Alarm message. Optional text which will be written out
 at alarm state if DetectOn is TRUE.

ReturnText Attribute
Class Attribute
Type String80
Flags
Body RtBody
 Return message. Text which will be written in the event
 list at return to normal state.

EventType Attribute
Class Attribute
Type UInt32
Flags
Body RtBody
 Specifies the type of the message (=DetectText ) which
 will be sent at alarm state.
 ALARM -- 64 The message always requires an
             acknowledgement and sent to the alarm

 INFO  -- 32 If the message requires acknowledgement is
             it sent to the info part of the alarm
             window and the event list, otherwise only

EventPriority Attribute
Class Attribute
Type UInt32
Flags
Body RtBody
 Priorities concerning alarm messages.

  -- 67   A-alarm; highest priority. (=43Hex)
  -- 66   B-alarm  (= 42Hex)
  -- 65   C-alarm  (= 41Hex)
  -- 64   D-alarm ; lowest priority. (=40Hex)

EventFlags Attribute
Class Attribute
Type UInt32
Flags
Body RtBody
 Bit map. A flag combination may be attached to the
 message:

 1  =   If this flag exists the return message
        ReturnText will be sent to the event lists of

 2  =   If this flag exists the acknowledgement message
        will be sent to the event lists of the out

 4  =   If the out unit has a peep-function this will
        be activated when the message is received.

 8  =   The message is sent to every out unit

 16 =   If the message is of the type INFO it will be
        placed in the event list. If this flag exists
        the message is also placed in the INFO square
        of the alarm window where acknowledgement is to

Sound Attribute
Class Attribute
Type AttrRef
Flags
Body RtBody
 Reference to a sound object, that defines the sound at the operator
 place when the alarm is active. If no sound object is supplied, an
 ordinary beep is used. The sound object should be of class Sound
 or SoundSequence

MoreText Attribute
Class Attribute
Type Text256
Flags
Body RtBody
 Optional text supplying more information about the event.
 The more text can for example contain actions to be made when an alarm is detected.

Recipient Attribute
Class Attribute
Type String40
Flags
Body RtBody
 Recipient for epost and mms alarms.
 The recipient is a user defined in the user database in the
 current system group.
 Recipient can also be a list of users separated by comma, eg
 'dennis, jimmy'. Also symbols defined in the Symbol table in
 the PostConfig object can be used. Symbols should be referenced
 with a $ sign before the symbol name, eg '$on_duty'.

 The users should be defined in the current system group or in a
 subgroup to this, If a subgroup is used, the subgroup should
 be specified in the recipient name, eg 'sms.dennis'.

Attribute Attribute
Class Attribute
Type AttrRef
Flags INVISIBLE
Body RtBody
 Attribute is filled in by the server process to the
 NodeLinkSup object itself.

AlarmStatus Attribute
Class Attribute
Type UInt32
Flags STATE | INVISIBLE
Body RtBody
 Status value. Bit map containing 16 bits where the 8
 least significant bits denote the state and the 8 most
 significant bits the priority.
 The state is a combination of:

    -- 0    Normal state
    -- 1    Alarm state
    -- 2    Unacknowledged alarm
 The priority is one of the priorities EventPriority.

 The following status can exist:
    EventPriority + 1 => Priority + alarm state
    EventPriority + 3 => Priority + unacknowledged alarm
 and alarm state

AlarmCheck Attribute
Class Attribute
Type Boolean
Flags STATE | INVISIBLE
Body RtBody
 Used internal at the event detection.

DetectCheck Attribute
Class Attribute
Type Boolean
Flags STATE | INVISIBLE
Body RtBody
 Specifies if an alarm state will be detected or not.
 FALSE means that an alarm state will not be detected;
 TRUE means that an alarm state will be detected.

DetectSend Attribute
Class Attribute
Type Boolean
Flags STATE | INVISIBLE
Body RtBody
 Specifies if the message has already been sent to the
 out units (or more precisely the message handler) or
 not. TRUE means that the message has been sent.

DetectTime Attribute
Class Attribute
Type Time
Flags STATE | INVISIBLE
Body RtBody
 Date and time when alarm state was detected.

ReturnCheck Attribute
Class Attribute
Type Boolean
Flags STATE | INVISIBLE
Body RtBody
 Specifies if the object has returned to normal state or
 not. TRUE means that the object has returned to normal
 state.

ReturnSend Attribute
Class Attribute
Type Boolean
Flags STATE | INVISIBLE
Body RtBody
 Specifies if the return message, ReturnText, has been
 sent to the out units or not. TRUE means that the
 return message has been sent.

ReturnTime Attribute
Class Attribute
Type Time
Flags STATE | INVISIBLE
Body RtBody
 Date and time when the last return to normal was
 detected.

AckTime Attribute
Class Attribute
Type Time
Flags STATE | INVISIBLE
Body RtBody
 Date and time when the last acknowledgement of normal
 state was detected.

AckOutunit Attribute
Class Attribute
Type Objid
Flags STATE | INVISIBLE
Body RtBody
 Identity of the out unit (operator) which made an
 acknowledgement.

TimerFlag Intern
Class Intern
Type Boolean
Flags STATE | INVISIBLE
Body RtBody
 Indicates an active timer.

TimerNext Intern
Class Intern
Type Pointer to Boolean
Flags POINTER | STATE | INVISIBLE | PRIVATE
Body RtBody
 Points to the next element in the timer queue.

TimerCount Intern
Class Intern
Type UInt32
Flags STATE | INVISIBLE
Body RtBody
 Number of remaining ticks.

TimerDO Intern
Class Intern
Type Pointer to Boolean
Flags POINTER | STATE | INVISIBLE | PRIVATE
Body RtBody

TimerTime Intern
Class Intern
Type Float32
Flags
Body RtBody
 Delay in seconds. Specifies when, since an alarm state
 has occurred, the message will be sent. If the alarm
 state disappears before the time has elapsed no message
 is generated.
 TimerTime >= the executing period of the PLC program.

TimerDODum Intern
Class Intern
Type Boolean
Flags STATE | INVISIBLE
Body RtBody

TimerObjDId Intern
Class Intern
Type Objid
Flags INVISIBLE
Body RtBody
 Identity of this object is set at load file creation.
 Used by the run time system.

TimerAcc Intern
Class Intern
Type Int32
Flags INVISIBLE
Body RtBody
 The operator's authorities to change TimerTime. Not
 implemented.

  0   -- Changes not allowed.
  !=0 -- Changes allowed.

TimerMin Intern
Class Intern
Type Float32
Flags INVISIBLE
Body RtBody
 Specifies a valid interval at changes made by the
 operator on TimerTime.

 TimerMin <= TimerTime <= TimerMax

TimerMax Intern
Class Intern
Type Float32
Flags INVISIBLE
Body RtBody

SystemStatus Intern
Class Intern
Type Status
Flags NOEDIT | STATE
Body RtBody
Contains the system status of the supervised node.
If the link is down, the status is PWR__NETTIMEOUT.