- Index
- »
- fan.hxConn
- »
- ConnExt
ConnExt
const abstract class ConnExt : ExtObj
Connector library base class. See Custom Connectors.
Constructor
List all the connectors
Settings record
Lookup a connector by its record id
Library level callback to process a connector learn
Return connector specific details to insert into debug report
Create default point tuning configuration for this library
Lookup a point by its record id
List all the points across all connectors
Get the conn model name which is used to map to tags
Start callback - if overridden you must call super
Return connector specific details to insert into debug report
Settings update - if overridden you must call super
Stop callback - if overridden you must call super
Conn? conn(Ref id, Bool checked)
Lookup a connector by its record id
Conn[] conns()
List all the connectors
new make()
Constructor
virtual Str modelName()
Get the conn model name which is used to map to tags:
- Library name: acme.foobar
- Model name: fooBar By default this is the last part of the library dotted name.
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.
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.
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.
virtual Void onSettings()
Settings update - if overridden you must call super
virtual Void onStart()
Start callback - if overridden you must call super
virtual Void onStop()
Stop callback - if overridden you must call super
ConnPoint? point(Ref id, Bool checked)
Lookup a point by its record id
ConnPoint[] points()
List all the points across all connectors
virtual ConnSettings settings()
Settings record
virtual ConnTuning tuningDefault()
Create default point tuning configuration for this library