@haxall/haxall
    Preparing search index...

    Class EcobeeThermostat

    Thermostat object

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    type$: Type

    Methods

    • Parameters

      • it: string

      Returns void

    • Parameters

      • it: string

      Returns void

    • Parameters

      • it: string

      Returns void

    • Parameters

      • it: string

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      • it: string

      Returns void

    • Parameters

      • it: string

      Returns void

    • Parameters

      Returns void

    • Parameters

      Returns void

    • Parameters

      • it: string

      Returns void

    • Parameters

      Returns void

    • Parameters

      Returns void

    • The thermostat brand

      Returns string

    • 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

      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)

      Parameters

      Returns number

    • Encode this object to a JSON string

      Returns string

    • Compare this object to the specified for equality. This method may be accessed via the == and != shortcut operators. If not overridden the default implementation compares for reference equality using the === operator. If this method is overridden, then hash() must also be overridden such that any two objects which return true for equals() must return the same value for hash(). This method must accept null and return false.

      Parameters

      Returns boolean

    • The status of all equipment controlled by this Thermostat. Only running equipment is listed in the CSV String.

      Returns string

    • The comma-separated list of the thermostat's additoinal features, if any

      Returns string

    • Return a unique hashcode for this object. If a class overrides hash() then it must ensure if equals() returns true for any two objects then they have same hash code.

      Returns number

    • Return the unique object id for this object if it has one; otherwise return null

      Returns string

    • The unique thermostat serial number

      Returns string

    • 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

      Returns boolean

    • Whether the user registered the thermostat

      Returns boolean

    • Get the name of the json key for this object when it is stored as the value in a json map.

      Example:
      EcobeeSelection => selection

      Returns string

    • The thermostat model number

      Returns string

    • A user defined name for the thermostat

      Returns string

    • If this object was constructed from a web response, this is the raw decoded JSON object.

      Returns Map<string, JsObj>

    • The runtime state object

      Returns EcobeeRuntime

    • The thermostat settings object

      Returns EcobeeSettings

    • The current thermostat configuration revision

      Returns string

    • 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

      Returns Readonly<this>

    • Return a string representation of this object.

      Returns string

    • 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])

      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.

      Parameters

      Returns JsObj

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

      Returns Type

    • Returns DateTime

    • The version object containing the firmware version for the thermostat

      Returns EcobeeVersion

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

      Parameters

      • f: (arg0: this) => void

      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.

      Parameters

      Returns void