Funcs
Funcs : Funcs
Return the points for a connector as list of dicts
Perform a ping on the given connector and return a future
Force the given connector closed and return a future
Perform a learn on the given connector and return a future
Perform a remote sync of current values for the given points
Perform a remote sync of history data for the given points
Return debug details for a connector or a connector point
Select a group of points explicitly via specific connector library or connector
Return true or false if given connector has its tracing enabled
Enable tracing on the given connector
Disable tracing on the given connector
Clear the trace log for the given connector
Disable tracing on every connector in the database
Read a connector trace log as a grid
(conn: Obj, checked: Bool) => List
Return the points for a connector as list of dicts. The conn
parameter may be anything accepted by toRecId(). If conn cannot be
be mapped to an active connector then raise an exception or return an
empty list based on checked flag.
Examples:
read(haystackConn).connPoints
connPoints(@my-conn-id)
(conn: Obj) => Future <admin>
Perform a ping on the given connector and return a future.
The future result is the connector rec dict. The conn parameter
may be anything accepted by toRecId().
Examples:
read(conn).connPing
connPing(connId)
(conn: Obj) => Future <admin>
Force the given connector closed and return a future.
The future result is the connector rec dict. The conn
parameter may be anything accepted by toRecId().
Examples:
read(conn).connClose
connClose(connId)
(conn: Obj, arg: Obj?) => Future <admin>
Perform a learn on the given connector and return a future.
The future result is the learn grid. The conn parameter may
be anything acceptable by toRecId(). The arg is an opaque
identifier used to walk the learn tree via the learn column.
Pass null for arg to return the root of the learn tree.
Examples:
connLearn(connId, learnArg)
(points: Obj) => List <admin>
Perform a remote sync of current values for the given points.
The points parameter may be anything acceptable by toRecIdList().
Return a list of futures for each unique connector. The result
of each future is unspecified. Also see Connectors.
Examples:
readAll(bacnetCur).connSyncCur
(points: Obj, span: Obj?) => Obj? <admin>
Perform a remote sync of history data for the given points.
The points parameter may be anything acceptable by toRecIdList().
The span parameter is anything acceptable by toSpan(). Or pass
null for span to perform a sync for items after the point's hisEnd.
This blocks the calling thread until each point is synchronized one
by one. Normally it should only be called within a task. The result
from this function is undefined. Also see Connectors.
Examples:
readAll(haystackHis).connSyncHis(null)
(obj: Obj) => Obj <admin>
Return debug details for a connector or a connector point. The argument is anything acceptable by toRecId(). The result is returned as a plain text string.
(points: Obj, libOrConn: Obj) => Obj <admin>
Select a group of points explicitly via specific connector library or connector. This function is required when points are associated with multiple connectors. Pass a connector library name to select for a protocol. Or pass a connector id/rec to select via a specific connector. Also see Connectors.
Examples:
// explicitly sync via the SQL connector library
readAll(sqlConnRef).connPointsVia("sql").connSyncHis
// get debug details for specific connector
connPointsVia(pt, pt->bacnetConnRef).connDetails
(conn: Obj) => Bool <admin>
Return true or false if given connector has its tracing enabled.
The conn parameter can be anything acceptable by toRecId().
(conn: Obj) => Obj? <admin>
Enable tracing on the given connector.
The conn parameter can be anything acceptable by toRecId().
(conn: Obj) => Obj? <admin>
Disable tracing on the given connector.
The conn parameter can be anything acceptable by toRecId().
(conn: Obj) => Obj? <admin>
Clear the trace log for the given connector.
The conn parameter can be anything acceptable by toRecId().
() => Obj? <admin>
Disable tracing on every connector in the database.
(conn: Obj, opts: Dict?) => Grid <admin>
Read a connector trace log as a grid. If tracing is not enabled
for the given connector, then an empty grid is returned. The conn
parameter may be anything acceptable by toRecId().
Examples:
read(conn).connTrace
connTrace(connId)