ArgyleDig alarms are special enhanced
version of digital alarms. These special alarms are not documented
in the online help or the manual set. These alarms are more
demanding on Citect and generate a higher CPU load on the alarm
server. Citect support does not provide support for this type of
alarms. You may use them at your own risk. The alarms have the
following features.
Alarm Tag
The name of the alarm.
Alarm Name
The name of the physical device associated with the alarm.
Alarm Desc
The description of the alarm.
The alarm tag, name and descriptions are to describe the alarm
to operators by displaying this text on the alarm page and alarm
log. The actual text is not interpreted by Citect, Citect just
displays what you enter into the alarm record. Under some cases you
may want to make the alarm tag unique for all alarms (see parameter
[ALARM]SaveStyle for details).
Var Tag A-C
The alarm state is controlled by three variables A, B and C. The
allows the alarm to have 8 unique states. If you only require 2 or
4 states you may leave some of the variables blank. When left blank
the field will default to 0.
Realarm
The alarm can be active in more than one state. If this property is
set then a new event will be generated when the alarm changes from
one alarm state to another alarm state. The ON function will be
called and a new event will be logged to the alarm summary and
devices.
State 000-CBA
With the three variables the alarm has 8 states. The state
properties specify which states are alarm states and what text
message is associated with each state. To make a state into an
alarm state add the description to the state field and put a 1 in
the next field. When the alarm enters this state it will be
triggered and the text will be displayed on the alarm page.
The state text is displayed in the alarm format {STATE_DESC} for
the alarm page and {OLD_STATE} for the alarm summary.
On function
A cicode command that is executed when this alarm is trigged. The
cicode must be non-blocking and must completely execute within the
foreground time slice. If the code takes longer than the foreground
time slice Citect will halt it and generate the hardware error
'Foreground cicode run too long'. If you call a blocking function
Citect will also halt the cicode and generate the hardware error
'cicode cannot block'. Citect does this so that you will not have
synchronise problems when the alarm is tripped continuously. For
example if you did a very complex operation which would take 2
seconds to execute and then alarm was tripped again within this
period, your code would start running twice and you may have
problems. Because of this Citect limits this type of execution. If
you want to start a long complex operation off this event then use
TaskNew() to create another task to process the operation. You must
allow for the case when the alarm is tripped again while the first
operation is still running.
Off function
A cicode command that is executed when this alarm is de-activated.
See description in On Function.
Category
The alarm category.
Help
The name of the graphics page that display when the AlarmHelp()
function is called
Privilege
The privilege required by an operator to acknowledge or disable the
alarm. If you do not specify a privilege, all operator can
acknowledge or disable the alarm.
Area
The area to which the alarm belongs. If an operator does not have
access to an area, the alarm is not visible on the alarm display.
If you do not specify an area, the alarms belongs to all areas.
Comment
Comment for the alarm record. Citect currently does not look at
this property, it is only for your internal documentation.
|