Constructor
new AlarmModel(siteId)
AlarmModel Constructor
Parameters
-
siteId
numberThe Site ID associated with this Alarm
Source
Members
autoResetboolean
Whether the Alarm should Automatically Reset
Type
-
boolean
Source
autoResetDelaynumber
The Delay before this Alarm should Auto Reset in Milliseconds
Type
-
number
Source
criticalboolean
Whether the Alarm is Critical or not
Type
-
boolean
Source
deletedboolean
Whether the Alarm has been deleted
Type
-
boolean
Source
groupIdstring
The Alarm Group this Alarm is a part of
Type
-
string
Source
idstring
The Alarm ID
Type
-
string
Source
internalResetStartPointnumber
The Point used to store the Alarm's Internal Reset Start
Type
-
number
Source
internalTripStartPointnumber
The Point used to store the Alarm's Internal Trip Start
Type
-
number
Source
namestring
The Alarm Name
Type
-
string
Source
resetDelaynumber
The Delay before this Alarm will Reset in Milliseconds
Type
-
number
Source
resetScriptstring
The Python Script with the Conditions to Reset this Alarm
Type
-
string
Source
rtuIdnumber
The RTU this Alarm belongs to
Type
-
number
Source
siteIdnumber
The Site ID associated with this Alarm
Type
-
number
Source
tripDelaynumber
The Delay before this Alarm will Trip in Milliseconds
Type
-
number
Source
trippedStatePointnumber
The Point used to store the Alarm Tripped State
Type
-
number
Source
trippedTimestampPointnumber
The Point used to store the Alarm Tripped Timestamp
Type
-
number
Source
tripScriptstring
The Python Script with the Conditions to Trip this Alarm
Type
-
string
Source
updateTimestampDate
When the Alarm was last updated
Type
-
Date
Source
Methods
fromJSON(json, siteId) → {AlarmModel}
Create a new AlarmModel from a JSON Object or JSON String
Parameters
-
json
Object.<string, any>|stringA JSON Object or JSON String
-
siteId
numberThe Site ID associated with this Alarm
Returns
-
AlarmModel