Allen-Bradley Logix5000 Reference Manual page 47

Input Parameter Data Type
AlarmCountReset BOOL
UseProgTime BOOL
ProgTime LINT
Severity DINT
MinDurationPRE DINT
Output Parameter Data Type
EnableOut BOOL
InAlarm BOOL
Acked BOOL
InAlarmUnack BOOL
Suppressed BOOL
Disabled BOOL
MinDurationACC DINT
AlarmCount DINT
InAlarmTime LINT
AckTime LINT
RetToNormalTime LINT
AlarmCountResetTime LINT
DeliveryER BOOL
DeliveryDN BOOL
FactoryTalk Alarms and Events Logix-based Instructions (ALMD, ALMA)
Description
Set by the user program to reset the alarm count. A cleared-to-set transition resets the alarm count to
zero.
Default is cleared.
Specifies whether to use the controller's clock or the ProgTime value to timestamp alarm state change
events. When set, the ProgTime value provides timestamp. When cleared, the controller's clock
provides timestamp.
Default is cleared.
If UseProgTime is set, this value is used to provide the timestamp value for all events. This lets the
application apply timestamps obtained from the alarm source, such as a sequence-of-events input
module.
Severity of the alarm. This does not affect processing of alarms by the controller, but can be used for
sorting and filtering functions at the alarm subscriber.
Valid = 1...1000 (1000 = most severe; 1 = least severe).
Default = 500.
Minimum duration preset (milliseconds) for the alarm condition to remain true before the alarm is
marked as InAlarm and alarm notification is sent to clients. The controller collects alarm data as soon
as the alarm condition is detected, so no data is lost while waiting to meet the minimum duration.
Valid = 0...2,147,483,647.
Default = 0.
Description
Enable output.
Alarm active status. Set when the alarm is active. Cleared when the alarm is not active (normal status).
Alarm acknowledged status. Set when the alarm is acknowledged. Cleared when the alarm is not
acknowledged.
Acked is always set when AckRequired is cleared.
Combined alarm active and acknowledged status. Set when the alarm is active (InAlarm is set) and
unacknowledged (Acked is cleared). Cleared when the alarm is normal (inactive), acknowledged, or
both.
Suppressed status of the alarm. Set when the alarm is suppressed. Cleared when the alarm is not
suppressed.
Disabled status of the alarm. Set when the alarm is disabled. Cleared when the alarm is enabled.
Elapsed time since the alarm was detected. When this value reaches MinDurationPRE, the alarm
becomes active (InAlarm is set), and a notification is sent to clients.
Number of times the alarm has been activated (InAlarm is set). If the maximum value is reached, the
counter leaves the value at the maximum count value.
Timestamp of alarm detection.
Timestamp of alarm acknowledgement. If the alarm does not require acknowledgement, this timestamp
is equal to alarm time.
Timestamp of alarm returning to a normal state.
Timestamp indicating when the alarm count was reset.
Delivery error of the alarm notification message. Set when there is a delivery error, either no alarm
subscriber was subscribed or at least one subscriber did not receive the latest alarm change state
message. Cleared when delivery is successful or is in progress.
Delivery completion of the alarm notification message. Set when delivery is successful, at least one
subscriber was subscribed and all subscribers received the latest alarm change state message
successfully. Cleared when delivery does not complete successfully or is in progress.
Rockwell Automation Publication 1756-RM003N-EN-P - October 2011
Chapter 1
47