Skip to main content
Version: v4 (Stable)

SetAlarm

SetAlarm(AlarmId AS String/Integer, Status AS Integer[, AlarmTime AS Time[, AlarmValue]]) AS Integer

Sets or resets the alarm tag identified by <AlarmId>. <AlarmId> can be the numeric object Id of the alarm tag or its alphanumeric identifier depending on the type of the parameter (Integer or String).

The <Status> parameter defines the action:

  • 1 = alarm activation
  • 0 = reset alarm

The optional parameter <AlarmTime> is used to provide the source time stamp of the alarm (local time).

The optional parameter <AlarmValue> updates the value of the alarm tag and sets or resets the alarm according to the alarm conditions defined, regardless of the value of the <Status> parameter.

Returns an error code (0 if no error, 6 if <AlarmId> not defined).