Skip to main content
Version: v4 (Stable)

CreateAlarm

CreateAlarm(AlarmId AS String, CallGroup AS String, AlarmGroup AS String, Message As String, Priority AS Integer, Flags AS Integer[, Format AS String[, nDelay AS Integer[, sStation AS String]]]) AS Integer

Creates an alarm defined by the string identifier <AlarmId>.

  • <CallGroup> defines the group to call (can be empty if not defined).
  • <AlarmGroup> defines the associated functional group (can be empty if not defined).
  • <Message> defines the message associated with the alarm.
  • <Priority> defines the alarm priority.
  • <Format> defines the display format of the message (optional).
  • <nDelay> defines the call delay (sec).
  • <sStation> defines the station where to create the alarm (local station by default).

<Flags> can contain the following boolean flags:

  • &h01 = Creates the on-call group if it doesn't exist.
  • &h02 = Transitory alarm (automatic reset).
  • &h04 = Temporary alarm (automatically destroyed when reset and acknowledged).
  • &h08 = Local alarm.
  • &h10 = Call group updated if the tag <AlarmId> is already defined.
  • &h20 = Message not updated if the tag <AlarmId> is already defined.
  • &h40 = Creating multi-station alarm group.
  • &h80 = Simple event.
  • &h100 = Reactive alarm.
  • &h200 = Group call disabled.

If the tag <AlarmId> is already defined, the parameters <Message>, <Priority> and <Format> are updated.

Returns an error code (0 if no error).