Class EcobeeLib

Return a negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified object:

this < that   =>  <0
this == that  =>  0
this > that   =>  >0
Copy

This method may also be accessed via the < <= <=> >= and > shortcut operators. If not overridden the default implementation compares the toStr representations. Also see docLang.

Examples:

3.compare(8)  =>  -1
8.compare(3)  =>  1
8.compare(8)  =>  0
3 <=> 8       =>  -1  // shortcut for 3.compare(8)
Copy

Lookup a connector by its record id

Dict with markers for supported features: learn, cur, write, his

Tag name for the connector records such as bacnetConnRef

List all the connectors

Tag name for the connector records such as bacnetConn

Equality is based on reference equality

Identity hash

Override to return non-null for onHouseKeeping callback

Icon logical name to use for this connector type library

Return if this Obj is immutable and safe to share between threads:

• an instance of a const class
• the result of toImmutable on List, Map, or Buf
• a Func object may or may not be immutable - see sys::Func.
• other instances are assumed mutable and return false

Running flag. On startup this flag transitions to true before calling ready and start on the library. On shutdown this flag transitions to false before calling unready and stop on the library.

Display name to use for connector library

Logger to use for this library

Library name

Number of configured connectors

Return list of observables this extension publishes. This method must be overridden as a const field and set in the constructor.

Subscribe this library to an observable. The callback must be an Actor instance or Method literal on this class. If callback is a method, then its called on the lib's dedicated background actor. pool. This method should be called in the onStart callback. The observation is automatically unsubscribed on stop. You should not unsubscribe this subscription - it must be managed by the extension itself. See docHaxall::Observables#fantomObserve.

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.

Callback made periodically to perform background tasks. Override houseKeepingFreq to enable the frequency of this callback.

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.

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.

Callback when all libs are fully started. This is called on dedicated background actor.

Record update - if overridden you must call super

Start callback - if overridden you must call super

Callback when runtime reaches steady state. This is called on dedicated background actor.

Stop callback - if overridden you must call super

Callback before we stop the runtime This is called on dedicated background actor.

Lookup a point by its record id

List all the points across all connectors

Settings record

Runtime

Return list of services this library publishes. This callback is made during initialization and each time a lib is added/removed from the runtime.

Observable subscriptions for this extension

Get an immutable representation of this instance or throw NotImmutableErr if this object cannot be represented as an immutable:

• if type is const, return this
• if already an immutable List, Map, Buf, or Func return this
• if a List, then attempt to perform a deep clone by calling toImmutable on all items
• if a Map, then attempt to perform a deep clone by calling toImmutable on all values (keys are already immutable)
• some Funcs can be made immutable - see sys::Func
• if a Buf create immutable copy, see sys::Buf
• any other object throws NotImmutableErr

Return name

Trap a dynamic call for handling. Dynamic calls are invoked with the -> shortcut operator:

a->x        a.trap("x", null)
a->x()      a.trap("x", null)
a->x = b    a.trap("x", [b])
a->x(b)     a.trap("x", [b])
a->x(b, c)  a.trap("x", [b, c])
Copy

The default implementation provided by Obj attempts to use reflection. If name maps to a method, it is invoked with the specified arguments. If name maps to a field and args.size is zero, get the field. If name maps to a field and args.size is one, set the field and return args[0]. Otherwise throw UnknownSlotErr.

Create default point tuning configuration for this library

Get the Type instance which represents this object's class. Also seeType.of or Pod.of.

Web service handling for this library

This method called whenever an it-block is applied to an object. The default implementation calls the function with this, and then returns this.

Write x.toStr to standard output followed by newline. If x is null then print "null". If no argument is provided then print an empty line.