Normal
Deprecated. Do not use in new code.
(Alarm Manager module)
Description: | Use this function to tell the Alarm Manager when an alarm clears. This subroutine will deactivate the alarm. It will not affect the unacknowledged status. |
Returns: | Numeric |
Usage: | Script Only. |
Function Groups: | Alarm |
Related to: | Register (Alarm Manager) | CurrentTime | IsActive |
Format: | \AlarmManager\Normal(AlarmObject[, EventTime]); |
Parameters: |
AlarmObject |
Required. The object value for the alarm that was passed to the Register subroutine. |
EventTime |
Optional. The time stamp to use when adding this event to the alarm lists. If invalid or not defined, the default is CurrentTime(). |
Comments: | The Normal subroutine always returns "0". |
Example:
To avoid an If 1 condition when normalizing an alarm, it is common practice to include a variable to ensure that the script runs only once. This should take its value from the current alarm state.
Init [ AlarmOn = AlarmManager\IsActive(MyAlarm); ] Main [ If value < SomeSetpoint && AlarmOn; [ AlarmOn = 0; AlarmManager\Active(MyAlarmObj); ]