Instruction Manual

i.LON 100 Internet Server Programmer’s Reference
Property Description
<UCPTalarmFlags>
This field is a series of seven Boolean values (0,1) separated by spaces
that determine what information will be stored in the Alarm History and
Alarm Summary Logs for this data point. The meanings of each byte in
the string are described below:
Byte 1 (log_enable): When this byte is set to 0, each new alarm will be
recorded in the Alarm History Log when it initially occurs. No further
entries will be recorded into the log for the alarm. When this byte is set
to 1, each new alarm will be recorded in the Alarm History Log when it
initially occurs, and additional entries in the Alarm History Log will be
added each time the status of the alarm changes. For example, an
additional entry would be added for an alarm when it is acknowledged or
cleared.
Byte 2 (invisible): When this byte is set to 0, alarm notifications for this
data point will be recorded in the Alarm Summary Log. When this byte is
set to 1, log entries for the data point will not be recorded in the Alarm
Summary Log.
Byte 3 (reserved): Set this byte to 0.
Byte 4 (clear_required): When this byte is set to 0, the log entries for
this data point will be automatically removed from the Alarm Summary
Log when the alarm associated with the entry is acknowledged, or the
alarm changes to a passive condition. You can acknowledge an alarm
with the AlarmNotifierWrite function. When this byte is set to 1, you will
need to clear all log entries from the Alarm Summary Log manually with
the AlarmNotifierWrite function.
Note that Byte 7 must be set to 0 to record log entries for the data point
into the summary log.
Byte 5 (ack_required): When this byte is set to 1, all log entries made
by the Alarm Notifier for this data point must be manually acknowlegded
with the AlarmNotifierWrite function. When this byte is set to 0, each
alarm triggered by the Alarm Notifier for this data point will be
automatically acknowledged. In this case, they will not be recorded in the
Alarm Summary Log if Byte 4 is also set to 0.
Note that Byte 7 must be set to 0 to record log entries for the data point
into the summary log.
Byte 6 (status_enabled): Not used. Set this byte to 0.
Byte 7 (cov_enabled): When this byte is set to 0, log entries for all
changes in the alarm status this data point will be stored in the Alarm
Summary Log. When this byte is set to 1, only the most recent change in
the data point’s alarm status will be logged by the Alarm Notifier in the
Alarm Summary Log.
Byte 3 and byte 6 should be left at 0. All other bytes can be set to ON (1)
or OFF (0) by writing to the property. For example, to turn all fields on
(except for reserved Bytes 3 and 6), enter the following string:
<UCPTalarmFlags>1 1 0 1 1 0 1</UCPTalarmFlags>
The default for this property is 0 0 0 0 0 0 0.
8-12