@haxall/haxall
    Preparing search index...

    Class EcobeeSettings

    Settings object

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    Methods

    __autoAway __autoHeatCoolFeatureEnabled __auxMaxOutdoorTemp __auxOutdoorTempAlert __auxOutdoorTempAlertNotifyTechnician __auxOutdoorTempAlertyNotify __auxRuntimeAlert __auxRuntimeAlertNotify __auxRuntimeAlertNotifyTechnician __backlightOffDuringSleep __backlightOffTime __backlightOnIntensity __backlightSleepIntensity __coldTempAlert __coldTempAlertEnabled __compressorProtectionMinTemp __compressorProtectionMinTime __condensationAvoid __coolingLockout __coolMaxTemp __coolMinTemp __coolRangeHigh __coolRangeLow __coolStages __dehumidfyWhenHeating __dehumidifierLevel __dehumidifierMode __dehumidifyOvercoolOffset __dehumidifyWithAC __disableAlertsOnIdt __disableHeatPumpAlerts __disablePreCooling __disablePreHeating __drAccept __eiLocation __electricityBillCycleMonths __electricityBillingDayOfMonth __electricityBillStartMonth __enableElectricityBillAlert __enableProjectedElectricityBillAlert __fanControlRequired __fanMinOnTime __fanSpeed __followMeComfort __groupName __groupRef __groupSetting __hasBoiler __hasDehumidifier __hasElectric __hasErv __hasForcedAir __hasHeatPump __hasHrv __hasHumidifier __hasUVFilter __heatCoolMinDelta __heatMaxTemp __heatMinTemp __heatPumpGroundWater __heatPumpReversalOnCool __heatRangeHigh __heatRangeLow __heatStages __holdAction __hotTempAlert __hotTempAlertEnabled __humidifierMode __humidity __humidityAlertNotify __humidityAlertNotifyTechnician __humidityHighAlert __humidityLowAlert __hvacMode __installerCodeRequired __isRentalProperty __isVentilatorTimerOn __lastServiceDate __locale __maxSetBack __maxSetForward __monthlyElectricityBillLimit __monthsBetweenService __quickSaveSetBack __quickSaveSetForward __randomStartDelayCool __randomStartDelayHeat __remindMeDate __serviceRemindMe __serviceRemindTechnician __smartCirculation __stage1CoolingDifferentialTemp __stage1CoolingDissipationTime __stage1HeatingDifferentialTemp __stage1HeatingDissipationTime __tempAlertNotify __tempAlertNotifyTechnician __tempCorrection __useCelsius __userAccessCode __userAccessSetting __userTimeFormat12 __useZoneController __vent __ventilatorDehumidify __ventilatorFreeCooling __ventilatorMinOnTime __ventilatorMinOnTimeAway __ventilatorMinOnTimeHome __ventilatorOffDateTime __ventilatorType __wifiOfflineAlert autoAway autoHeatCoolFeatureEnabled auxMaxOutdoorTemp auxOutdoorTempAlert auxOutdoorTempAlertNotifyTechnician auxOutdoorTempAlertyNotify auxRuntimeAlert auxRuntimeAlertNotify auxRuntimeAlertNotifyTechnician backlightOffDuringSleep backlightOffTime backlightOnIntensity backlightSleepIntensity coldTempAlert coldTempAlertEnabled compare compressorProtectionMinTemp compressorProtectionMinTime condensationAvoid coolingLockout coolMaxTemp coolMinTemp coolRangeHigh coolRangeLow coolStages dehumidfyWhenHeating dehumidifierLevel dehumidifierMode dehumidifyOvercoolOffset dehumidifyWithAC disableAlertsOnIdt disableHeatPumpAlerts disablePreCooling disablePreHeating drAccept eiLocation electricityBillCycleMonths electricityBillingDayOfMonth electricityBillStartMonth enableElectricityBillAlert enableProjectedElectricityBillAlert encode equals fanControlRequired fanMinOnTime fanSpeed followMeComfort groupName groupRef groupSetting hasBoiler hasDehumidifier hasElectric hasErv hasForcedAir hash hasHeatPump hasHrv hasHumidifier hasUVFilter heatCoolMinDelta heatMaxTemp heatMinTemp heatPumpGroundWater heatPumpReversalOnCool heatRangeHigh heatRangeLow heatStages holdAction hotTempAlert hotTempAlertEnabled humidifierMode humidity humidityAlertNotify humidityAlertNotifyTechnician humidityHighAlert humidityLowAlert hvacMode id installerCodeRequired isImmutable isRentalProperty isVentilatorTimerOn jsonKey lastServiceDate locale maxSetBack maxSetForward monthlyElectricityBillLimit monthsBetweenService quickSaveSetBack quickSaveSetForward randomStartDelayCool randomStartDelayHeat remindMeDate resJson serviceRemindMe serviceRemindTechnician smartCirculation stage1CoolingDifferentialTemp stage1CoolingDissipationTime stage1HeatingDifferentialTemp stage1HeatingDissipationTime tempAlertNotify tempAlertNotifyTechnician tempCorrection toImmutable toStr trap typeof useCelsius userAccessCode userAccessSetting userTimeFormat12 useZoneController vent ventilatorDehumidify ventilatorFreeCooling ventilatorMinOnTime ventilatorMinOnTimeAway ventilatorMinOnTimeHome ventilatorOffDateTime ventilatorType wifiOfflineAlert with echo make

    Constructors

    Properties

    type$: Type

    Methods

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      • it: string

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      • it: string

      Returns void

    • Parameters

      • it: string

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      • it: string

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      • it: string

      Returns void

    • Parameters

      • it: string

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      • it: string

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      • it: string

      Returns void

    • Parameters

      • it: string

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      • it: string

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      Returns void

    • Parameters

      • it: string

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      • it: string

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      • it: string

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      • it: string

      Returns void

    • Parameters

      • it: string

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • When set to true if no occupancy motion detected thermostat will go into indefinite away hold, until either the user presses resume schedule or motion is detected.

      Returns boolean

    • If enabled, allows the Thermostat to be put in HVACAuto mode.

      Returns boolean

    • The maximum outdoor temperature above which aux heat will not run.

      Returns number

    • The temperature at which an auxOutdoor temperature alert is triggered.

      Returns number

    • Whether the auxOutdoor temperature alerts for the technician are enabled.

      Returns boolean

    • Whether the auxOutdoor temperature alerts are enabled.

      Returns boolean

    • The temperature at which an auxHeat temperature alert is triggered.

      Returns number

    • Whether the auxHeat temperature alerts are enabled.

      Returns boolean

    • Whether the auxHeat temperature alerts for the technician are enabled.

      Returns boolean

    • Determines whether or not to turn the backlight off during sleep.

      Returns boolean

    • The time in seconds before the thermostat screen goes into sleep mode

      Returns number

    • The thermostat backlight intensity when on. A value between 0 and 10, with 0 meaning off - the zero value may not be honored by all ecobee versions

      Returns number

    • The thermostat backlight intensity when asleep. A value between 0 and 10, with 0 meaning off - the zero value may not be honored by all ecobee versions

      Returns number

    • The temperature at which a cold temp alert is triggered

      Returns number

    • Whether cold temperature alerts are enabled

      Returns boolean

    • 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

    • The minimum outdoor temperature that the compressor can operate at

      • applies more to air source heat pumps than geothermal

      Returns number

    • The minimum time the compressor must be off for in order to prevent short-cycling

      Returns number

    • Whether the thermostat is in frost control mode

      Returns boolean

    • This field represents whether to permit the cooling to operate when the Outdoor temperature is under a specific threshold, currently 55F. The default value is false.

      Returns boolean

    • The maximum cool set point allowed by the thermostat firmware.

      Returns number

    • The minimum cool set point allowed by the thermostat firmware.

      Returns number

    • The maximum cool set point configured by the user's preferences.

      Returns number

    • The minimum heat set point configured by the user's preferences.

      Returns number

    • The number of cool stage the connected HVAC equipment supports

      Returns number

    • This field represents whether to permit dehumidifier to operate when the heating is running. The default value is false.

      Returns boolean

    • The dehumidification set point in percentage.

      Returns number

    • The dehumidifier mode. Values: on, off. If set to off then the dehumidifier will not run, nor will the AC overcool run.

      Returns string

    • Whether the thermostat should use AC overcool to dehumidify and what that temperature offset should be. A value of 0 means this feature is disabled and dehumidifyWithAC will be set to false. Value represents the value in F to subtract from the current set point. Values should be in the range 0

      • 50 and be divisible by 5.

      Returns number

    • Whether the thermostat should use AC overcool to dehumidify. When set to true a positive integer value must be supplied for dehumidifyOvercoolOffset otherwise an API validation exception will be thrown.

      Returns boolean

    • Whether alerts are disabled from showing on the thermostat.

      Returns boolean

    • Whether heat pump alerts are disabled.

      Returns boolean

    • Whether the thermostat should use pre cooling to reach the set point on time.

      Returns boolean

    • Whether the thermostat should use pre heating to reach the set point on time.

      Returns boolean

    • Whether Demand Response requests are accepted by this thermostat. Possible values are: always, askMe, customerSelect, defaultAccept, defaultDecline, never.

      Returns string

    • A note about the physical location where the SMART or EMS Equipment Interface module is located

      Returns string

    • The owners billing cycle duration in months.

      Returns number

    • The day of the month the owner's electricity usage is billed.

      Returns number

    • The annual start month of the owners billing cycle.

      Returns number

    • Whether electricity bill alerts are enabled.

      Returns boolean

    • Whether electricity bill projection alerts are enabled

      Returns boolean

    • 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

    • Whether fan control by the Thermostat is required in auxiliary heating (gas/electric/boiler), otherwise controlled by furnace.

      Returns boolean

    • The minimum time, in minutes, to run the fan each hour. Value from 1 to 60.

      Returns number

    • What's the default Fan Speed on a HVAC with multi-span. Accepted values: low, medium, high, and optimized.

      Returns string

    • When set to true if a sensor has detected presence for more than 10 minutes then include that sensor in temp average. If no activity has been seen on a sensor for more than 1 hour then remove this sensor from temperature average.

      Returns boolean

    • The name of the the group this thermostat belongs to, if any. See GET Group request and POST Group request for more information.

      Returns string

    • The unique reference to the group this thermostat belongs to, if any. See GET Group request and POST Group request for more information.

      Returns string

    • The setting value for the group this thermostat belongs to, if any. See GET Group request and POST Group request for more information.

      Returns number

    • Whether the thermostat is controlling a boiler

      Returns boolean

    • Whether the thermostat is connected to a dehumidifier. If true or dehumidifyOvercoolOffset > 0 then allow setting dehumidifierMode and dehumidifierLevel.

      Returns boolean

    • Whether the thermostat is connected to an electric HVAC system.

      Returns boolean

    • Whether the thermostat is controlling an energy recovery ventilator

      Returns boolean

    • Whether the thermostat is controlling a forced air furnace

      Returns boolean

    • 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

    • Whether the thermostat is controlling a heat pump

      Returns boolean

    • Whether the thermostat is controlling a heat recovery ventilator

      Returns boolean

    • Whether the thermostat is controlling a humidifier

      Returns boolean

    • This Boolean field represents whether the HVAC system has a UV filter. The default value is true.

      Returns boolean

    • The minimum temperature difference between the heat and cool values. Used to ensure that when thermostat is in auto mode, the heat and cool values are separated by at least this value.

      Returns number

    • The maximum heat set point allowed by the thermostat firmware.

      Returns number

    • The minimum heat set point allowed by the thermostat firmware.

      Returns number

    • Whether the Thermostat uses a geothermal / ground source heat pump.

      Returns boolean

    • The flag to tell if the heat pump is in heating mode or in cooling when the relay is engaged. If set to zero it's heating when the reversing valve is open, cooling when closed and if it's one - it's the opposite.

      Returns boolean

    • The maximum heat set point configured by the user's preferences.

      Returns number

    • The minimum heat set point configured by the user's preferences.

      Returns number

    • The number of heat stages the connected HVAC equipment supports

      Returns number

    • The default end time setting the thermostat applies to user temperature holds. Values useEndTime4hour, useEndTime2hour (EMS Only), nextPeriod, indefinite, askMe

      Returns string

    • The temperature at which a hot temp alert is triggered

      Returns number

    • Whether hot temperature alerts are enabled

      Returns boolean

    • The humidifier mode. Values: auto, manual, off

      Returns string

    • The minimum humidity level (in percent) set point for the humidifier

      Returns string

    • Whether humidification alerts are enabled to the thermostat owner.

      Returns boolean

    • Whether humidification alerts are enabled to the technician associated with the thermostat.

      Returns boolean

    • The humidity level to trigger a high humidity alert.

      Returns number

    • The humidity level to trigger a low humidity alert.

      Returns number

    • The current HVAC mode the thermostat is in. Values: auto, auxHeatOnly, cool, heat, off

      Returns string

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

      Returns string

    • Whether an installer code is required

      Returns boolean

    • 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 property is a rental, or not

      Returns boolean

    • This Boolean field represents whether the ventilator timer is on or off. The default value is false. If set to true the ventilatorOffDateTime is set to now() + 20 minutes. If set to false the ventilatorOffDateTime is set to it's default value.

      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 last service data of the HVAC equipment

      Returns Date

    • Multilanguage support

      Returns string

    • The maximum automated set point set back offset allowed in degress

      Returns number

    • The maximum automated set point set forward offset allowed in degrees

      Returns number

    • The dollar amount the owner specifies for their desired maximum electricity bill.

      Returns number

    • The user configured monthly interval between HVAC service reminders

      Returns number

    • The set point set back offset, in degrees, configured for a quick save event

      Returns number

    • The set point set forward offset, in degrees, configured for a quick save event

      Returns number

    • Whether random start delay is enabled for cooling.

      Returns number

    • Whether random start delay is enabled for heating

      Returns number

    • Date to be reminded about the next HVAC service date

      Returns Date

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

      Returns Map<string, JsObj>

    • Whether to send an alert when service is required again.

      Returns boolean

    • Whether the technician associated with this thermostat should receive the HVAC service reminders as well.

      Returns boolean

    • When set to true if a larger than normal delta is found between sensors the fan will be engaged for 15min/hour.

      Returns boolean

    • The difference between current temperature and set-point that will trigger stage 2 cooling.

      Returns number

    • The time after a cooling cycle that the fan will run for to extract any cooling left in the system - 30 second default (for not)

      Returns number

    • The difference between current temp and set-point that will trigger stage 2 heating

      Returns number

    • The time after a heating cycle that the fan will run for to extract any heating left in the system - 30 second default.

      Returns number

    • Whether temperature alerts are enabled to the thermostat owner

      Returns boolean

    • Whether temperature alerts are enabled to the technician associated with the thermostat.

      Returns boolean

    • The amount to adjust the temperature reading in degrees F - this value is subtracted from the temperature read from the sensor.

      Returns number

    • 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

    • Whether the thermostat is configured to report in degrees Celsisus

      Returns boolean

    • The user access code value for this thermostat. See the SecuritySettings object for more information.

      Returns string

    • The integer representation of the user access settings. See the SecuritySettings object for more information.

      Returns number

    • Whether the thermostat is using 12hr time format

      Returns boolean

    • Whether to use a zone controller or not

      Returns boolean

    • The ventilator mode. Value: auto, minontime, on, off

      Returns string

    • This field represents whether or not to allow dehumidification when cooling. The default value is true.

      Returns boolean

    • Whether to use the ventilator to dehumidify when climate or calendar event indicates the owner is home. The default value is false.

      Returns boolean

    • The minimu time in minutes the ventilator is configured to run. The thermostat will always guarantee that the ventilator runs for this minimum duration whenever engaged.

      Returns number

    • The number of minutes to run ventilator per hour when away.

      Returns number

    • The number of minutes to run ventilator per hour when home.

      Returns number

    • This read-only field represents the Date and Time the ventilator will run until. The default value is 2014-01-01 00:00:00.

      Returns string

    • This read-only field represents the type of ventilator present for the Thermostat. The possible values are none, ventilator, hrv, and erv.

      Returns string

    • Whether the alert for when wifi is offline is enabled.

      Returns boolean

    • 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