lib

lib:conn

Connector framework

meta

tags

actorTimeout

Timeout for messages send to the connector's actor thread

conn

Connector for communication to a remote system

connErr

Error message associated when connStatus indicates an error condition

connFeatures

Defines the features supported by a given connector

connLinger

Linger timeout used to keep a connector open

connOpenRetryFreq

Duration used for connector open retries

connPingFreq

Duration used to configure the auto-ping feature on a given connector

connPoint

Point associated with a connector for data synchronization with a remote system

connState

Current connection state of a connector as one of the predefined strings

connStatus

Current status of a connector as one of the predefined strings See Connectors

connTuning

Marker applied to a rec which defines a tuning configuration

connTuningRef

Reference to a tuning configuration defined by a connTuning rec

curCalibration

Calibration value to apply to adjust the value read from the connector before updating curVal

curConvert

Conversion to apply when reading curVal from connector

hisConvert

Conversion to apply when reading history data from connector

pointConvert

Point value conversion used to normalize data to/from a remote system

pollTime

Frequency between polls of curVal

staleTime

Time before a point's curStatus marked from "ok" to "stale" See Connector Tuning

writeConvert

Conversion to apply when writing writeVal to the connector

writeMaxTime

Maximum time between writes used to send periodic writes

writeMinTime

Minimum time between writes used to throttle the speed of writes

writeOnOpen

Issue a write every time the connector transitions from open to closed

writeOnStart

Issue a write when the system first starts up

funcs

connClose

Force the given connector closed and return a future

connDetails

Return debug details for a connector or a connector point

connLearn

Perform a learn on the given connector and return a future

connPing

Perform a ping on the given connector and return a future

connPoints

Return the points for a connector as list of dicts

connPointsVia

Select a group of points explicitly via specific connector library or connector

connSyncCur

Perform a remote sync of current values for the given points

connSyncHis

Perform a remote sync of history data for the given points

connTrace

Read a connector trace log as a grid

connTraceClear

Clear the trace log for the given connector

connTraceDisable

Disable tracing on the given connector

connTraceDisableAll

Disable tracing on every connector in the database

connTraceEnable

Enable tracing on the given connector

connTraceIsEnabled

Return true or false if given connector has its tracing enabled