Methods
getDefinition(siteId, pointId) → {PointModel|undefined}
Get Point Definition
Parameters
-
siteId
numberThe Site ID
-
pointId
numberThe Point ID
Returns
-
PointModelundefined- The Point Definition
Source
getValue(siteId, pointId) → {Points.PointValueItem|undefined}
Get Point Value
Parameters
-
siteId
numberThe Site ID
-
pointId
numberThe Point ID
Returns
-
Points.PointValueItemundefined- The Point Value
Source
initialize()
Initialize
Source
isInitialized() → {boolean}
Returns the Initialized Status
Returns
-
boolean
Source
off(event, handler)
Un-Register Events Handler
Parameters
-
event
stringThe Event to Un-Register a Handler from
-
handler
Points.eventCallbackThe Handler Callback
Source
offReadPoints(handler)
Un-Register 'readpoints' Event Handler
Parameters
-
handler
Points.readPointsCallbackThe Handler Callback
Source
on(event, handler)
Register Events Handler
Parameters
-
event
stringThe Event to Register a Handler for
-
handler
Points.eventCallbackThe Handler Callback
Source
onReadPoints(handler)
Register 'readpoints' Event Handler
Parameters
-
handler
Points.readPointsCallbackThe Handler Callback
Source
setValue(siteId, pointId, value) → {Promise.<string>}
Set Point Value
Parameters
-
siteId
numberThe Site ID
-
pointId
numberThe Point ID
-
value
anyThe Point Value to Write
Returns
-
Promise.<string>
Source
subscribe(siteId) → {Promise.<boolean>}
Subscribe to a Site for Points
Parameters
-
siteId
numberThe Site ID
Returns
-
Promise.<boolean>
Source
unsubscribe(siteId)
Unsubscribe from a Site for Points
Parameters
-
siteId
numberThe Site ID
Source
Type Definitions
eventCallback(…args) → {void}
The Events Callback
Parameters
-
args
any<repeatable>
The Callback Arguments
Returns
-
void
Source
PointValueItem
A Point Value Item used in a Read Points Callback
Type
-
Object
Properties
-
id
numberThe Point ID
-
value
anyThe Point Value
-
timestamp
DateWhen the Point Value last changed
Source
readPointsCallback(siteId, pointValues) → {void}
The Read Points Callback
Parameters
-
siteId
numberThe Site ID
-
pointValues
Array.<Points.PointValueItem>An Object of Point Values
Returns
-
void