type

ConnLib

abstract const class ConnLib : HxLib

Connector library base class. See Custom Connectors.

constructors

make

Constructor

methods

conn

Lookup a connector by its record id

conns

List all the connectors

onConnDetails

Return connector specific details to insert into debug report.

onLearn

Library level callback to process a connector learn.

onPointDetails

Return connector specific details to insert into debug report.

onRecUpdate

Record update - if overridden you must call super

onStart

Start callback - if overridden you must call super

onStop

Stop callback - if overridden you must call super

point

Lookup a point by its record id

points

List all the points across all connectors

rec

Settings record

tuningDefault

Create default point tuning configuration for this library

Slot Details

conn

Conn? conn(Ref id, Bool checked := true)

Lookup a connector by its record id

conns

Conn[] conns()

List all the connectors

make

new make()

Constructor

onConnDetails

virtual Str onConnDetails(Conn conn)

Return connector specific details to insert into debug report. Connectors should avoid requiring a message to the Conn actor so that debug can proceed even if the actor is blocked on I/O. Utilize Conn.data to cache debug information.

onLearn

virtual Future onLearn(Conn conn, Obj? arg)

Library level callback to process a connector learn. The default operation dispatches to the connector actor, performs an open, and then callback to to ConnDispatch.onLearn. However, some connectors can perform a learn operation without using an open connector (for example using configuration files). In that case, use this hook to process the learn request without dispatching to the Conn actor.

onPointDetails

virtual Str onPointDetails(ConnPoint point)

Return connector specific details to insert into debug report. Connectors should avoid requiring a message to the Conn actor so that debug can proceed even if the actor is blocked on I/O. Utilize ConnPoint.data to cache debug information.

onRecUpdate

virtual override Void onRecUpdate()

Record update - if overridden you must call super

onStart

virtual override Void onStart()

Start callback - if overridden you must call super

onStop

virtual override Void onStop()

Stop callback - if overridden you must call super

point

ConnPoint? point(Ref id, Bool checked := true)

Lookup a point by its record id

points

ConnPoint[] points()

List all the points across all connectors

rec

virtual override ConnSettings rec()

Settings record

tuningDefault

virtual ConnTuning tuningDefault()

Create default point tuning configuration for this library