search

SANdood / Ecobee-Suite

Ecobee Suite is for integrating Ecobee thermostats & sensors with the Hubitat home automation platform
109 stars 152 forks source link

readme

Universal Ecobee Suite, Version 1.8.00

NOTICE: Latest updates posted 14 February 2023 at 7:30am

Overview

Ecobee Suite is a collection of applications and device drivers that serve to integrate Ecobee Thermostats with the Hubitat Elevation home automation platform.

As of release 1.9.00 in February 2023, this project no longer contains any code for the SmartThings Platform. This is because the owners of the SmartThings platform decided to deprecate and eliminate support for groovy=based cloud devices, which this project is in it entirety.

Offering more robust resiliency and availability than the standard Ecobee support provided by both platforms, this Ecobee Suite provides unprecedented access to the operation and settings of Ecobee 3, Ecobee 4, Ecobee Lite and even most EMS, Smart and Smart Si thermostats. And while it can be used alongside (most) other Ecobee solutions on Hubitat, its comprehensive support of the Thermostat attributes, commands and APIs defined by Hubitat makes it a drop-in replacement as well.

The Ecobee Suite offers more than a dozen curated Helper applications that provide integration and automation without requiring any programming skills. And for those who DO want to write their own code in the Hubitat IDE, or by utilizing WebCoRE and/or Rules Engine, the Ecobee Suite provides a comprehensive set of API's capable of monitoring, managing and changing most all of the Ecobee thermostats' capabilities.

Table of Contents

Introduction

This document describes the various features related to the Ecobee Suite of device drivers and supporting Helper applications for Ecobee thermostats and sensors.

The following components are part of the Suite:

Applications

Device Drivers

Here are links to the working version of the repository being developed and maintained:

Motivation

I maintain the original intent as was previously defined by the original author Sean Stryker:

The intent is to provide an Open Source integration for Ecobee thermostats that can be used by the Hubitat user community free of charge and without fear of the device disappearing in the future. This will help ensure accessibility for all users and provide for an easy mechanism for the community to help maintain/drive the functionality.

Let me be clear: this is not a competition. I am not trying to replace or outdo any other version, and I personally have nothing against people making money off of their efforts. I have invested a lot of my time in this as Open Source so as to meet my own wants and desires, and I offer the result back to the community with no strings attached.

Please feel free to try any version you want, and pick the one that best fits your own use case and preference.

If you like this version and are so inclined, post a brief message of support on the Hubitat Community links above. And if you don't like it, or have any problems with the installation or operation of the suite, please also post on the links above. I strive for total transparency, and your use of this Suite does not require you to post positive reviews, nor are you prohibited in any way from posting negative reviews.

Donations

This work is fully Open Source, and available for use at no charge.

While not required, I do humbly accept donations. If you would like to make an optional donation, I will be most grateful. You can make donations to me on PayPal at https://paypal.me/BarryABurke

What's New

Key enhancements in Version 1.9.**

The most significant changes in this release is the complete removal of all of my code that supported integration with SmartThings. As noted elsewhere, this is because SmartThings no longer supports Groovy-based apps or drivers, as of 1 January 2023.

In addition, this release includes the following updates:

Special Thanks to Hubitat Staff

The author extends a special thank you to the Hubitat staff for assistance in getting the code-based Ecobee authentication working, as the documented Hubitat OAuth path doesn't work for Ecobee. Read through the OAuth init code in Ecobee Suite Manager to learn the (clever) trick they helped me employ.

A Note on Hubitat Performance

Over the years, I have invested heavily in reducing the CPU and memory overhead of the entire Ecobee Suite, especially on the Hubitat platform. With Version 1.9.*]* I have also removed all of the code related to SmartThings support, including the numerous conditional platform chacks that enabled specific optimizations for certain command calls. The resulting release is noticably faster in retrieving data from the Ecobee servers and deploying it to the various Helpers and device drivers. This effort, coupled with continuous improvement of the Hubitat environment itself, has helped make Ecobee Suite far more efficient than it has ever been.

Installation

Hubitat Installation

The EASIEST way to install Ecobee Suite on Hubitat is to use the Hubitat Package Manager (HPM), as this will automate the installation of the 13 Applications and 2 device drivers. Simply install HPM, then select Ecobee Suite to install. Then you can skip to the next section to complete the installation and configuration.

But if you insist on doing it manually, follow these instructions:

Installation Preparation

Hubitat users should already be familiar with installing third-party drivers and applications from within the Hubitat Console. If not, the following instructions will provide step-by-step instructions to guide you through the process.

The entire install process is performed from within the Hubitat Console, and you'll want to have this document in one browser window/tab while you use the Hubitat console in another.

If you have been running the pre-release Beta code of Ecobee Suite on your Hubitat platform, the URL for the file imports will change, from the universal-dev branch to the master branch of the GitHub repository. The updated links are provided below.

Installing Manually (via Import)

The process for importing the files is the same for the Ecobee Suite Drivers and the Applications, using the appropriate <> Drivers Code and <> Apps Code menus (respectfully). Note that in total there are 14 files that you will need to install, and ALL of them must be installed in the order described below for the Ecobee Suite to install, initialize and operate properly.

Installing Applications

Open the Hubitat Console in your browser of choice, and then:

  1. Click on <> Apps Code in the left menu to open the Apps Code page
  2. Click on the + New App button at the top right of the page
  3. From the "New App" edit page, click on the Import button at the top of the page
  4. Copy the Ecobee Suite Manager link and paste it into the "Import Code from Website" overlay
  5. Click the Import button on the overlay
  6. Click the Save button in the editor page to complete the installation of the Ecobee Suite Manager app
  7. Repeat steps 1-6 again, using each of the following links to install the rest of the Suite's applications
    A. ecobee Suite Open Contacts
    B. ecobee Suite Quiet Time
    C. ecobee Suite Routines
    D. ecobee Suite Smart Circulation
    E. ecobee Suite Smart Humidity
    F. ecobee Suite Smart Mode
    G. ecobee Suite Smart Room
    H. ecobee Suite Smart Switches
    I. ecobee Suite Smart Vents
    J. ecobee Suite Smart Zones
    K. ecobee Suite Thermal Comfort
    L. ecobee Suite Working From Home

This completes the applications code loading portion of the Ecobee Suite installation process.

Installing Device Drivers

Open the Hubitat Console in your browser of choice, and then:

  1. Click on <> Drivers Code in the left menu to open the Drivers Code page
  2. Click on the + New Driver button at the top right of the page
  3. From the "New Driver" edit page, click on the Import button at the top of the page
  4. Copy the Ecobee Suite Sensor link and paste it into the "Import Code from Website" overlay
  5. Click the Import button on the overlay
  6. Click the Save button in the editor page to complete the installation of the Ecobee Suite Sensor driver
  7. Repeat steps 1-6 again, using the Ecobee Suite Thermostat link, this time.

This completes the drivers code loading portion of the Ecobee Suite installation process.

Enabling OAuth

Finally, we must enable OAuth for Ecobee Suite Manager as follows:

NOTE: This is the most commonly missed set of steps, but failing to enable OAuth will generate cryptic errors later when you try to use the Suite. So please don't skip these steps.

Once again, from the Hubitat Console (in your browser):

  1. Click on <> Apps Code in the left-hand menu
  2. Click the entry for Ecobee Suite Manager
  3. On the edit page, click on the OAuth button at the top of the page
  4. Click on the Enable OAuth in App button in the overlay
  5. Click on the Update button at the bottom of the overlay, then click on the Close button
  6. Finally, click on the Save button at the top of the edit page

This completes the process of enabling OAuth for the Ecobee Suite installation. Now we can create and configure the Ecobee Suite for your thermostats and sensors.

Finalizing the Installation in Hubitat Console

The final steps for installing the Ecobee Suite are completed entirely using the Ecobee Suite Manager App from the Hubitat console. The App will guide you through the basic installation and setup process. It includes the following aspects:

  • Authentication with Ecobee to allow API Calls for your thermostat(s) (and connected sensors)
  • Discovery, selection and creation of Thermostat devices
  • Discovery, selection and creation of Remote Sensor devices (if there are any)
  • Setup of optional features/parameters such as Smart Auto Temp Control, Polling Intervals, etc
  • Installation and configuration of Helper SmartApps (as desired)

Follow these steps to create and configure Ecobee Suite Manager from the Hubitat Console in your browser:

  1. Click on Apps in the left-hand menu
  2. Click on the Add User App button at the top-right of the Apps page
  3. Click on the Ecobee Suite Manager entry in the "Install New User App" overlay
  4. Select the Ecobee API Authorization page and then the Ecobee Account Authorization page to enter your Ecobee Credentials (this will open in a new browser window on your desktop)
  5. Enter your Ecobee account's Email and Password, and then press the green LOG IN button
  6. On the next page, Click Accept to allow Hubitat to connect to your Ecobee account
  7. You should receive a message indicating Your ecobee Account is now connected to Hubitat!
  8. Manually close the browser window
  9. Click Done at the bottom of the page
  10. Click Done again to save the credentials and exit out of Ecobee Suite Manager

You should now be back at the "Apps" page, with a new entry for "Ecobee Suite Manager Online" (the word Online should be green). From here, we go back into Ecobee Suite Manager to complete the inatllation and configuration:

  1. Click on the Ecobee Suite Manager App that you just installed. Once loaded, you should see several new submenus, including the ones for "Thermostats" and "Sensors"
  2. Click on the Thermostats submenu
  3. Select the Ecobee Thermostat devices you want to connect from your account
  4. Click the Done button to save your selected thermostats and close the Thermostats sub menu
  5. If your Ecobee thermostat has any sensors that you want to include, click on the "Sensors" submenu, select the Sensors, and click Done to save the sensors.

Note that the Ecobee Suite Manager menu options are dynamic and will change/appear based on other selections. E.g., you won't see any Thermostats to select if your Ecobee account login failed; you won't see any Sensors to choose until you select the thermostats they are connected to)

  1. You can also go into the Preferences section to set various preferences such as Hold Type, Smart Auto Temperature, Polling Interval, Debug Level, Decimal Precision, and whether to create separate sensor objects for thermostats.]
  2. After making all your desired selections, Click Done to save your preferences and exit the App

At this point, Ecobee Suite Manager will automatically create all of the new devices, one for each thermostat and sensor. These will show up in your regular Devices list within the Hubitat Console.

Using the default settings is fine, but some of the more advanced features will require you to change the default settings for Ecobee Suite. My recommended settings are:

  • Hold Type: If not specified, this will default to the setting on the thermostat itself. Some of the helper SmartApps allow you to customize this for specific operations.
  • Polling Interval: 1 minute if you are using Helper SmartApps to react to thermostat conditions (like changing to heating/cooling, or running a specific Program/Climate); otherwise 2-5 minutes might be sufficient.
  • Decimal Precision: One of the reasons I created this in the first place is to get more precision out of the thermostat. If you set this to 1 decimal position, you'll understand better how the thermostat is reacting to your environment, and when "72°" is really "72.4°".
  • Debug Level: I tend to run with this set to 2 because I've optimized this level to provide the most basic of operational status in the Live Logging monitor.

NOTE 1: It may take 5-10 minutes (longer if you use the default Polling Interval) for the new devices to show up in the Drivers list and for them to populate their attributes and states.

NOTE 2: If you uninstall the Ecobee Suite Manager app it will automatically remove all of the thermostats and sensors that it previously installed. This is necessary (and expected) as those devices are "children" of the App.

Congratulations! You have completed the installation of the Ecobee Suite into your Hubitat environment.

Features

General

This collection of applications and device drivers has been designed for simple installation, flexibile configuration options and easy operation. It is also extensible through the use of child Helper applications that can easily be added to the configuration. And it fully implements the related Hubitat Capabilities.

Key Highlights include:

SmartThings/Hubitat Platform Integration

Operational Enhancements (aka "Why Ecobee Suite")

Operational Efficiency
Timeout Handling

The stock Ecobee support on Hubitat does not consistently handle Ecobee server connection issues very well. That implementation will often drop the connection altogether at the slightest issue. Users are often required to manually re-authenticate in order to bring their thermostats back on-line

Beginning with 1.3.0, this Ecobee Suite will silently retry connection timeouts without sending any notifications (it will report warnings in Live Logging). Usually such timeouts are transient, and the side effect is only a delayed update. For lengthy outages, the code should automatically reconnect once the Ecobee Servers come back on line.

Thus, if you receive a notification that you need to re-authorize, you probably really do need to reauthorize.

Stacked Holds

Ecobee devices natively support a concept of "stacked" holds - each hold operation can be stacked on top of a prior hold, such that Resuming the current hold merely "pops the stack" to the prior hold. This is a very difficult concept to manage across multiple interfaces, because it is difficult to depict what the result of a "Resume" operation will be at any given point in time.

The Ecobee Suite implementation avoids the complexity by supporting only a single depth of Hold: events - whenever you execute a Resume you reset the thermostat to run the currently scheduled Program.

Ecobee Suite Manager Helper

The Ecobee Suite Manager application provides a single interface for accessing installation, updates, Child Helpers and even debugging tools. The interface uses dynamic pages to guide the user through the installation process in order simplify the steps as much as possible.

The SmartApp provides the following capabilities:

Contacts & Switches Helper

The ecobee Suite Open Contacts Helper can detect when one (or more) contact sensors (such as doors and windows) are left open or a configurable amount of time and can automatically turn off the HVAC and/or send a notification when it is detected.

This Helper also supports switches/dimmers/vents, with configurable selection of whether contact open or close, switch on or off will turn off the HVAC. This enhancement allows (for example) automatically turning off the HVAC when the attic fan is running.

Beginning with Ecobee Suite release 1.5.*, this Helper now also integrates with the new Quiet Time Helper SmartApp - instead of turning off the HVAC, this Helper can turn on/off the Virtual Switch that a Quiet Time Helper instance uses as its trigger. Quiet Time offers additional flexibility over the actions taken on the HVAC system (see documentation below).

Features

Quiet Time Helper

The ecobee Suite Quiet Time Helper allows you to automatically turn off or change some or all of the following HVAC system settings, based on the (configurable) off/on state of a specific (real or virtual) Switch:

When the aforementioned Quiet Time switch state changes back to (on/off), some or all of the above changes are reverted.

Using a Virtual Switch with Quiet Time

While Quiet Time can be triggered by any Switch device, it is perhaps most useful to trigger it using a Virtual Switch.

Once you have your virtual switch, simply configure this Helper to invoke Quiet Time actions when the virtual switch is turned on, and you're all set. Then add turning on this Virtual Switch to your Watch TV routine, or as an action for your Hubitat-integrated Harmony remote.

If you have Alexa (or Google Home), you even say "Alexa, turn on Quiet Time" and smile when your HVAC shifts into peaceful existence!

N.B., The use case for this new Helper came from a user whose HVAC system is rather noisy when the humidifier runs - enough so that it was hard to hear the TV on "movie night." He asked for the ability to automatically turn off the humidifier when the TV was turned on; from that was born the notion of this new Quiet Time Helper (and the ability to control the humidifier/dehumidifier). I'm sure there are several other use cases that can leverage Quiet Time.

Mode(/Routine)/Switches/Program` Helper Updated!

The ecobee Suite Routines Helper provides the ability to change the running Program (Comfort Setting) when the Location Mode is changed, when a Switch (real or virtual) is turned on/off. It can also be initiated by a Program (Schedule/Climate) change on an Ecobee thermostat.

Features

Smart Circulation Helper

The Ecobee Suite Smart Ciculation Helper SmartApp will adjust fan mininum on time of an Ecobee thermostat as it tries to get two or more temperature sensors to converge.

Beginning with Ecobee Suite release 1.5.*, Smart Circulation can be configured to disable circulation altogether (sets fanMinOnTime to 0) when the specified (Quiet Time) (real or virtual) Switch is turned off/on. If you want Quiet Time to really stop everything, then you need to enable this feature, otherwise Smart Circulation will override Quiet Time by setting the minimum on time to a non-zero number.

Features:

Smart Humidity Helper

The Ecobee Suite Smart Humidity Helper will adjust the humidity setpoint of your Ecobee Thermostat based on outdoor temperature, indoor temperature , and the thermal efficiency (rate of heat/humidity loss) of your structure.

To configure Smart Humidity, select an ES Thermosta and specify your desired minimum and maximimum humidity level.

Then you will estimate the number of days it takes your structure to shed excess humidity. This number defines the range of the strategy you select next. Generally, a larger number of days is required when your house is extremely well sealed; smaller values are used for older homes and homes with less efficient windows.

Next, elect one of the 3 provided Smart Humidity strategies:

Finally, select an efficiency factor. This factor effectively adds or reduces the calculated target Humidity Setpoint by a number of percentage points.

Configuration Advice The "ideal" indoor humidity is widely-accepted to fall within the 40-50% range. However, as the outside temperature drops, the probability that indoor humidity will condense on windows, metal doors, and exposed attic surfaces increases. Condensation is bad because it can promote and support the growth of mold and mildew in hidden areas of your home.

The ideal configuration for each home will be different, but generally you are trying to hold the humidity in the 40-50% range at all outdoor temperatures, without condensation. If you see condensation on a particularly cold day, you want to adjust things to reduce the target humidity when it is very cold. I recommend that you ONLY adjust the efficiency factor at first.

Features:

This Helper was added at user request, by a user who was continually frustrated by the "Frost Free" setting on the thermostat.

Smart Mode, Program & Setpoints Helper

This Helper will automatically change Ecobee Thermostats' Mode based on external temperature and/or dewpoint changes. Generally, the intention is to run Cool or Heat only modes when the outside temperatures might otherwise cause cycling between Heat/Cool if "Auto" were selected. Can also be used to turn the HVAC off when outdoor temperatures warrant leaving the windows open. Version 1.7.12 adds ability to change the Program/Climate/Schedule as well.

Features

Many thanks to @JustinL for the original idea, the starting code base, and beta testing for this new Smart Mode Helper.

Smart Room Helper

The ecobee Suite Smart Room Helper will automate a normally unused room, Activating it one or more of the Doors associated with the Smart Room are left open for a configurable number of minutes, and Deactivating it when all the Doors are closed for a configurable number of hours.

Requirements

Optional

Features

Smart Switches/Dimmer/Vent Helper

ecobee Suite Smart Switches Helper enables activating switches or dimmers based upon the Operating State of a thermostat. This is useful to control a vent airflow booster, an attic fan, a ceiling fan, and the like.

NOTE: the response time of this Helper is dependent upon the Polling Frequency set for Ecobee Suite Manager. If your Polling Frequency is 3 (for example), it can take as long as 6 minutes AFTER your HVAC starts heating/cooling before this app realizes that the HVAC has been turned on. Thus, it is best that you use this Helper with a Polling Frequency of 1 minute.

Smart Vents & Switches Helper

ecobee Suite Smart Vents automates one or more vents to reach/maintain a target temperature that you specify or from a specified thermostat. It uses one or more temperature devices, and opens/closes vents based upon current temperature, target temperature and thermostat operating state.

Smart Zones Helper

ecobee Suite Smart Zones Provides functionality to allow one or more "slave" zones to leverage the operating state of a "master" zone. This is designed for multi-zoned HVAC systems with only a single air handler. In this configuration, running only 1 zone (e.g., to cool) can cause the other zone's temperature to increase a few 10ths of a degree. This Helper seeks to address that by turning on the Slave zones' fan, thereby allowing some of the cooled (or heated) air into the slave zone.

In most cases, the Slave will properly reset any program Holds that are in effect when it starts 'leeching'.

Thermal Comfort Helper

This Helper dynamically adjusts the heating and/or cooling setpoints of Ecobee Suite Thermostats based on the concept of Thermal Comfort (see https://en.wikipedia.org/wiki/Thermal_comfort).

Using the Predicted Mean Vote (PMV) algorithm, Thermal Comfort setpoints will changed based entirely on the ambient indoor relative humidity and your selected activity and clothing levels. You may want to create different instances for different seasons and/or activities.

The Helper's dynamic configuration calculator within settings enables you to see the resultant setpoints based upon your PMV inputs in real time.

Working From Home Helper

ecobee Suite Working From Home is designed to override the thermostat's Program/Climate/Schedule changes if someone is still at home. It can be configured to check at a specific time on specific days of the week (e.g., shortly after the scheduled weekday program change on the thermostat), or it can check whenever the Thermostat Program changes to "Away."

Troubleshooting

The most common error conditions are related to Ecobee Server outages, which have increased in frequency significantly starting in late 2018 and continuing into 2019.

It is important to understand that the Ecobee Suite code is today extremely resilient and tolerant of these Ecobee Server outages. Generally, you need to do NOTHING when they occur - the code will attempt to reconnect repeatedly until it is successful because the servers came back on-line. During such an outage, you will see repeated timeout warnings in the Live Logging for Ecobee Suite Manager. If you see these, you need only wait until the systems recover.

The only time you should have to re-authenticate to recover from an outage is if the outage lasts so long that the Ecobee Servers invalidate your authentication. This usually doesn't happen, even for outages several hours long. You will know that you need to re-authenticate when one of these events occur:

If this occurs, simply open Ecobee Suite Manager and select the Ecobee API Authorization submenu to log in again - and yes, do this even though it might say that you are already connected. If the Ecobee servers are in fact back on-line, everything should start working again within the next few minutes.

For other issues:

Symptom Possible Solution
Receive error similar to "error java.lang.NullPointerException: Cannot get property 'authorities' on null object" This indicates that you have not turned on OAuth for Ecobee Suite Manager. Please review the installation instructions and complete the OAuth steps.
"You are not authorized to perform the requested operation." This indicates that you have not turned on OAuth for Ecobee Suite Manager. Please review the installation instructions and complete the OAuth steps.
Irregular behavior after an update to the application and/or thermostat code It is possible that after updating the codebase you may experience strange behavior, including possible app crashes. There have been complaints from the Hubitat community. Try the following steps:
1) Re-run the Ecobee Suite Manager application to re-initialize the devices
2) If that does not solve the problem, you may have to remove and re-install the entire Ecobee Suite (boo!!!).
physicalgraph.exception.ConflictException: Device still in use. Remove from any Applications or Dashboards, then try again @line -1 (doCall) The initial installation failed for some reason, and it was unable to delete the temporary devices it creates. Try removing everything that you can again, and then go to the on-line IDE. There, list your devices, and delete ANY that have “Ecobee-Suite” (or any form of that text) in their device ID. Then rerun Ecobee Suite Manager from the SmartApps Marketplace.

Debug Level

The Ecobee Suite Manager application allows the end user to configure the Debug Level they wish to use (ranging from 1-5). The higher the level the more debug information is fed into Live Logging on the Hubitat IDE.

Also, if a user chooses Debug Level 5, then a new Debug Dashboard will appear within ES Manager. This dashboard gives direct access to various state information of the app as well as a few helper functions that can be used to manaually trigger actions that are normally timer based.

Live Logging on IDE

The Live Logging feature on the Hubitat IDE is an essential tool in the debugging process of any issues that may be encountered.

To access the Live Logging feature on Hubitat, select Logs from the left menu, then Live Log from the top menu.

Installed Helper Info

Hubitat

On Hubitat, you can get detailed information for any App. Simply select the App from the Apps page, and then click on the Gear icon at the top-left of the page.

Quick Links

Reporting Issues

All issues or feature requests should be submitted to the latest release thread on the Hubitat Community. For the major release version 1.9.**, please use the thread on Hubitat

If you have complaints, please email them to me directly at either storageanarchy@gmail.com or to @storageanarchy on the Hubitat Communities.

License

The Ecobee Suite is licensed under the Apache License, Version 2.0 (the "License"); you may not use this Suite except in compliance with the License. You may obtain a copy of the License at: http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Integrating With Ecobee Suite Devices

The Ecobee Suite's thermostat devices can be leveraged by other custom applications, by the Hubitat Rule Manager, and by WebCoRE automations in a variety of ways. The provided Ecobee Thermostat Device implements the following SmartThings capability sets completely (click each capability for the SmartThings Developer Documentation describing each capability):

It is thus possible to subscribe to state changes associated with these capabilities, and to send commands to the devices using the standard command sets these capabilities define.

Because the currently defined Capabilities do not fully expose ALL of the native capabilities of Ecobee thermostats, several additional attributes (states) and commands have been added.

Annotated List of Supported Device Attributes (States)

Follows is the complete list of attributes (states) that the DTH maintains and exposes. You can find more information on the ES and EC attributes in the Ecobee API documentation

(Src: ES=Ecobee Setting, EC=Ecobee Configuration, int=Ecobee Suite internal-use)

Attribute Sample Value Data Type Read Only Src Description
alertsUpdated 2020-02-13 07:32:52 number yes int thermostat time of last update to alerts
apiConnected full string yes int Status of Ecobee Server accessibility. One of 'full', 'warn', 'lost'
autoAway false string no ES If true, switch to away when no motion detected
autoHeatCool
FeatureEnabled		 true string no ES Enable "Auto" mode
autoMode true string yes int Short-name status of autoHeatCoolFeatureEnabled
auxHeatMode false string yes int True if currently using auxHeat
auxMaxOutdoor
Temp		 70.0 number no ES Max temp that auxHeat will be called for
auxOutdoor
TempAlert		 50.0 number no ES Send alert if auxHeat being used above this temp
auxOutdoor
TempAlertNotify		 false string no ES Send auxOutdoorTempAlerts to the user
auxOutdoor
TempAlert
NotifyTechnician		 false string no ES Send auxOutdoorTempAlerts to the Technician
auxRuntimeAlert 10800 number no ES Send alert if auxHeat runs longer than this number of seconds
auxRuntimeAlert
Notify		 false string no ES Send auxRuntimeAlerts to user
auxRuntimeAlert
NotifyTechnician		 false string no ES Send auxRuntimeAlerts to technician
backlightOffDuring
Sleep		 true string no ES Turn backlight off when running the Sleep program
backlightOffTime 10 number no ES Turn off the backlight after this many seconds
backlightOnIntensity 10 number no ES Sets backlight intensity (0-10)
backlightSleep
Intensity		 4 number no ES Sets backlight intensity during Sleep program (0-10
brand ecobee string yes EC Thermostat's brand (see also modelNumber)
checkInterval 960 number yes int Health Check Interval
climatesList [Home, Away, Sleep] JSON_
OBJECT		 yes ES List of supported climates (programs)
USAGE: List theClimates = stat.currentValue( 'climatesList' )[1..-2].tokenize(', ')
climatesUpdated 2020-02-13 07:32:52 number yes int thermostat time of last update to
program.climates
coldTempAlert 53.0 number no ES Alert when thermostat reads internal temperature below this
coldTempAlert
Enabled		 true string no ES Send coldTempAlerts to user
compressor
Protection
MinTemp		 40.0 number no ES Minimum outside temp to run the A/C compressor
compressor
Protection
MinTime		 300 number no ES Minimum rest time after compressor is shut off
condensationAvoid false string no ES Auto adjust humidity levels based on outside temps & window efficiency Deprecated - Ecobee now uses humidifierMode = Auto
coolAtSetpoint 78.5 number yes int Actual temperature above which a demand for Cool will be made
coolDifferential 0.5 number yes int Temperature adder to coolingSetpoint to calculate coolAtSetpoint
coolMaxTemp 120.0 number yes ES Maximum temp that the thermostat hardware will accept for a cooling setpoint
coolMinTemp -10.0 number yes ES Minimum temp that the thermostat hardware will accept for a cooling setpoint
coolMode true string yes int Whether or not this thermostat is controlling a cooling unit
coolRange (65..92) string yes int Range of temps allowed for coolingSetpoint - use coolRangeHigh and coolRangeLow to change this
coolRangeHigh 92.0 number no ES Maximum allowed coolingSetpoint as configured by user
coolRangeLow 65.0 number no ES Minimum allowed coolingSetpoint as configured by user
coolStages 1 number yes ES Number of cooling stages the HVAC supports
coolingLockout false string no ES Allow demand for cool if outside temp is below compressorProtectionMinTemp
coolingSetpoint 78.0 number no ES Actual cooling setpoint
coolingSetpoint
Display		 78.0 number yes int Internally generated setpoint display value
coolingSetpointMax 92.0 number yes int Another name for coolRangeHigh (thanks to SmartThings we have at least 4 different representations of these values)
coolingSetpointMin 65.0 number yes int Another name for coolRangeLow
coolingSetpoint
Range		 [65, 92] vector3 yes int Yet ANOTHER name for the cooling range
coolingSetpointTile 78.0 number yes int Internal representation of the cooling setpoint for painting certain tiles
currentProgram Away string yes int Currently running Program/Climate/Schedule. See programsList for the list of Programs this thermostat supports. Use setThermostatProgram() or setSchedule() to change programs
currentProgramId away string yes ES Thermostat's actual internal name for currentProgram
currentProgram
Name		 Away string yes int Name of the current program; may be in form of "Hold: Away" or "Hold: Temp"
debugEventFrom
Parent		 XXX string yes int Last debug message sent by Ecobee Suite Manager to this thermostat
debugLevel 2 number no int Display debug message at this level or lower. Accepted range (1-5). Use Ecobee Suite Manager/Preferences to change
decimalPrecision 1 number no int Display this # of digits to right of decimal. Use Ecobee Suite Manager/Preferences to change
dehumidifierLevel 60 number no ES Relative Humidity target % for Dehumidifier
dehumidifierMode off string no ES Operating mode of the Dehumidifier (off, auto, on)
dehumidifyOvercool
Offset		 2.0 number no ES Degrees lower than coolingSetpoint that the thermostat can use the A/C for dehumidification
dehumidifyWhen
Heating		 false string no ES Whether the dehumidifier can run during demand for heating
dehumidifyWithAC true string no ES Whether the thermostat is allowed to place a demand for cooling to reduce the humidity
dehumiditySetpoint 60 number no int Same as dehumidifierLevel
disableAlertsOnIdt false string no ES Disables showing alerts on the Thermostat device
disableHeatPump
Alerts		 false string no ES Disables alerts related to the heat pump
disablePreCooling false string no ES Disables Smart pre-cooling
disablePreHeating false string no ES Disables Smart pre-heating
drAccept always string no ES Whether Demand Response requests are accepted by this thermostat (always, askMe, customerSelect, defaultAccept, defaultDecline, never)
ecobeeConnected true string yes int Whether or not Ecobee Suite Manager is able to communicate with the thermostat
eiLocation null string no ES A note about the physical location where the SMART or EMS Equipment Interface module is located.
electricityBill
CycleMonths		 1 number no ES Self-explanatory
electricityBill
StartMonth		 1 number no ES Self-explanatory
electricityBilling
DayOfMonth		 1 number no ES Self-explanatory
enableElectricity
BillAlert		 false string no ES Whether electricityBillAllerts are enabled
enableProjected
ElectricityBillAlert		 false string no ES Whether projected...Alerts are enabled
equipmentOperating
State		 idle string yes int List of equipment that is currently running (heating/cooling with stages,heat pump,humidifying,dehumidifying,fan only,auxHeat,idle,...)
equipmentStatus idle string yes int Equipment status (idle, off, offline, ...)
fanControlRequired true string no ES Whether thermostat or HVAC is controlling the fan
fanMinOnTime 20 number no ES Minimum number of minutes per hour the fan should run (sum of heat/cool + fan only runtime)
fanSpeed low string no ES Current fan speed of the thermostat (one of the listed fanSpeedOptions)
fanSpeedOptions ["low", "high"] JSON List yes ES List of supported fan speeds (based off of thermostat configuration & wiring)
features Home, HomeKit string yes ES List of features this thermostat supports
followMeComfort false string no ES Whether thermostat should use remote sensors to adjust setpoints based on occupancy/presence/motion
groupName XXX string no ES The name of the the group this thermostat belongs to, if any
groupRef XXX string no ES The unique reference to the group this thermostat belongs to, if any
groupSetting XXX string no ES The setting value for the group this thermostat belongs to, if any
hasBoiler false string yes ES Self-explanatory
hasDehumidifier true string yes ES Self-explanatory
hasElectric false string yes ES Self-explanatory
hasErv false string yes ES Self-explanatory
hasForcedAir true string yes ES Self-explanatory
hasHeatPump false string yes ES Self-explanatory
hasHrv false string yes ES Self-explanatory
hasHumidifier true string yes ES Self-explanatory
hasUVFilter true string yes ES Self-explanatory
heatAtSetpoint 59.5 number yes int Actual temperature below which a demand for Heat will be made
heatCoolMinDelta 4.0 number no ES Minimum number of degrees allowed between Heating and Cooling setpoints
heatDifferential 0.5 number no ES Temperature subtracted from heatingSetpoint to calculate heatAtSetpoint
heatMaxTemp 120.0 number yes ES Maximum temp that the thermostat hardware will accept for a heating setpoint
heatMinTemp 45.0 number yes ES Minimum temp that the thermostat hardware will accept for a heating setpoint
heatMode true string no ES Whether this thermostat is controlling an HVAC that can provide heat
heatPump
GroundWater		 false string yes ES Whether this heat pump uses underground water, or is air-cooled
heatPump
ReversalOnCool		 true string no ES Whether the thermostat should reverse the heat pump's coolant direction when cooling
heatRange (45..78) string yes int Range of temps allowed for heatingSetpoint - use heatRangeHigh and heatRangeLow to change this
heatRangeHigh 78.0 number no ES Maximum configured heatingSetpoint allowed
heatRangeLow 45.0 number no ES Minimum configured heatingSetpoint allowed
heatStages 2 number yes ES Number of stages the heating component of the HVAC system supports
heatingSetpoint 60.0 number no ES Actual heating setpoint
heatingSetpoint
Display		 60.0 number yes int Internal display representation of the heatingSetpoint
heatingSetpointMax 78.0 number yes int Same as heatRangeHigh
heatingSetpointMin 45.0 number yes int Same as heatRangeLow
heatingSetpoint
Range		 [45, 78] vector3 yes int Yet another way to present the heatingSetpoint range (thanks, SmartThings, for not making up your mind)
heatingSetpointTile 60.0 number yes int Internal representation of heating setpoint for a tile's display
holdAction nextPeriod string no int The default end time setting the thermostat applies to a temperature or program hold (useEndTime4hour, useEndTime2hour, nextPeriod, indefinite, askMe
holdEndDate 2020-02-19 18:30:00 string yes int Date & time that the current hold will end (in thermostat time format)
holdEndsAt 6:30pm string yes int timeToday() the current hold ends
holdStatus Hold ends at 6:30pm string yes int String displayed in the SmartThings UI to show when the current hold will end
hotTempAlert 87.0 number no ES Temperature above which a Hot Temp alert will be generated
hotTempAlert
Enabled		 true string no ES Whether hotTempAlerts are sent
humidifierMode auto string no ES One of (auto, manual, off)
humidity 36 number no ES Current Relative Humidity reading at the thermostat
humidityAlertNotify true string no ES Should humidity alerts be sent to the user
humidityAlert
NotifyTechnician		 false string no ES Should humidity alerts be sent to the technician
humidityHighAlert 80 number no ES Alert if inside relative humidity is above this %
humidityLowAlert -1 number no ES Alert if inside relative humidity is below this %
humiditySetpoint 50 number no ES Current humidify-to setpoint
humiditySetpoint
Display		 50 number yes int Internal display value of the humidity setpoint
identifier XXX string yes ES Serial number of this thermostat
installerCode
Required		 false string no ES Whether the installer code is required to make changes to this thermostat
isRegistered true string yes ES Whether the user registered this thermostat
isRentalProperty false string no ES Whether the property is a rental property (restricts some changes)
isVentilator
TimerOn		 false string no ES Whether the ventilator timer is on (default=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.
lastHoldType indefinite string yes int The last holdType that was requested of Ecobee Suite for this thermostat
lastModified date-str string yes int Date & time of the last update received from the Ecobee servers
lastOpState heating string yes int Last operating state for this thermostat (updated when thermostatOperatingState changes to idle or off).
lastPoll Succeeded string yes int Status of the last poll of the Ecobee Servers
lastServiceDate date-str string no ES Date of the last HVAC service
locale en string no ES Current locale (only 'english' is currently supported)
maxSetBack 10.0 number no ES Max setback that a demandResponse can execute
maxSetForward 8.0 number no ES Max setforward that a demandResponse can execute
mobile iOS string yes int Use Ecobee Suite Manager/Preferences to change
modelNumber athenaSmart string yes EC Model number (string) for this thermostat
monthlyElectricity
BillLimit		 0 number no ES Self-explanatory
monthsBetween
Service		 6 number no ES Self-explanatory
motion inactive string yes int Whether motion has been detected
name Downstairs string yes EC Thermostat name (configured at the thermostat only)
programsList ["Home", "Sleep", "Awake", "Away"] JSON List yes int JSON-formatted list of Programs/Climates/Schedules supported on this thermostat - auto generated.
USAGE: List thePrograms = new JsonSlurper().parseText( stat.currentValue( 'programsList' ))
programUpdated 2020-02-13 07:32:52 number yes int thermostat time of last update to thermostat.program
quickSave
SetBack		 4.0 number no ES The setpoint setback offset, in degrees, configured for a quick save event
quickSave
SetForward		 4.0 number no ES The setpoint setforward offset, in degrees, configured for a quick save event
randomStart
DelayCool		 0 number no ES if non-zero, the max minutes a cooling random start can use
randomStart
DelayHeat		 0 number no ES If non-zero, the max minutes a heating random start can use
remindMeDate 2019-07-08 string no ES Date to send an alert reminder (HVAC service, filters, etc.)
schedText forever string yes int Internal text for how long the current hold is scheduled for
schedule Away String yes int Same as currentProgram - use setThermostatProgram() or setSchedule() to change. Note that when in a Hold, the schedule string will be in this form:
Hold: Away until 2020-02-19 18:30:00
scheduled
Program		 Away string yes int The program that is scheduled to be running now (may be different than currentProgram
scheduled
ProgramId		 away string yes int Internal ID of the scheduled program
scheduled
Program
Name		 Away string yes int The proper name of the scheduled program
serviceRemindMe true string no ES Whether the thermostat should remind you of upcoming service
serviceRemind
Technician		 false string no ES Whether the technician should be notified of service
smartCirculation false string no ES If enabled, thermostat should operate like Smart Circulation. Unfortunately, at this time it does nothing
soundAlertVolume 0 number no ES (Deprecated) Volume for alerts
soundTickVolume 0 number no ES (Deprecated) Volume for ticks
stage1Cooling
DifferentialTemp		 0.5 number no ES The difference between current temperature and set-point that will trigger stage 2 cooling.
stage1Cooling
DissipationTime		 31 number no ES Seconds after a cooling cycle that the fan will run for to extract any cooling left in the system. '31' means "auto"
stage1Heating
DifferentialTemp		 0.5 number no ES The difference between current temperature and set-point that will trigger stage 2 heating.
stage1Heating
DissipationTime		 31 number no ES The time after a heating cycle that the fan will run for to extract any heating left in the system. '31' means "auto"
statHoldAction nextPeriod string yes int Same as holdAction
supported
Thermostat
FanModes		 ["on", "auto", "circulate", "off"] JSON List yes int Self-explanatory
supported
Thermostat
Modes		 ["off", "auto", "cool", "heat"] JSON List yes int Self-explanatory
supported
VentModes		 ["off"] JSON List yes int Self-explanatory
tempAlertNotify true string no ES Send temperature alerts to user
tempAlertNotify
Technician		 false string no ES Send temperature alerts to techinician
tempCorrection -1.0 number no ES Degrees added/subtracted to thermostat temp readings
temperature 72.9 number yes ES Current temperature
temperatureDisplay 72.9° string yes int Display value of current temperature
temperatureScale F string yes int Temperature scale in use
thermostatFanMode auto string yes ES Current fan mode. Must be one of supportedThermostatFanModes
thermostatFanMode
Display		 circulate string yes int Current fan mode display ("circulate" when fanMinOnTime != 0)
thermostatHold hold string yes int If not null, type of hold (hold, vacation, temp)
thermostatMode heat string no ES Current thermostat mode. Must be one of supportedThermostatModes
thermostatOperating
State		 idle string yes int One of (heating,cooling,fan only, idle,heat pending, cool pending)
thermostatOperating
StateDisplay		 idle string yes int Display value of thermostatOperatingState
thermostatRev XXX string yes ES Hardware revision of this thermostat
thermostatSetpoint 60.0 number yes int Yet another way SmartThings once requested that setpoints be displayed
thermostatStatus Resume Program succeeded string yes int Most recent text for the thermostat device's status display
thermostatTime date-str string yes ES Time from the thermostat for the most recent update
timeOfDay day string yes int "day" or "night"
userAccessCode null string yes ES Current user Access Code (clear text)
userAccessSetting 0 number yes ES Integer representation of the user access settings
vent off string yes int Equivalent of ventMode
ventMode off string no ES See supportedVentModes
ventilator
Dehumidify		 true string no ES Whether to use the ventilator to dehumidify
ventilator
FreeCooling		 true string no ES Whether to use the ventilator to help with cooling
ventilator
MinFreeOnTime		 20 number no ES Minimum minutes per hour to run the ventilator
ventilator
MinOnTimeAway		 0 number no ES Minimum minutes when in Away program
ventilator
MinOnTimeHome		 20 number no ES Minimum minutes when in Home program
ventilator
OffDateTime		 null string no ES date & time the timed ventilation will stop (see isVentilatorTimerOn)
ventilatorType none string yes ES One of (none, ventilator, hrv, erv)
weatherDewpoint 47.4 number yes ES Self-explanatory
weatherHumidity 68 number yes ES Self-explanatory
weatherPressure 29.83 number yes ES Self-explanatory
weatherSymbol 0 number yes ES Index of the icon for the current weather conditions
weatherTemperature 57.9 number yes ES Self-explanatory
weatherTemp
LowForecast		 20.3,9.2,4, 22.9,21.1 string yes int Forecast low temperatures for today and the next 4 days (in °F) - used by Smart Humidity
wifiOfflineAlert false string yes ES True if Ecobee servers have lost connection to the thermostat device (usually means a wifi or internet outage at your location)

In addition to the above, there are several internal-use-only attributes that should not be used in any manner by end-users or programmers. These include: tstatDate, tstatTime, setAway, setSleep, setHome, resumeProgram, setModeOff, setModeAuto, setModeHeat, setFanOff, and setModeCool.

Supported Commands

Ecobee Suite Thermostat Commands

The complete set of *Thermostat DTH commands that can be called programmatically follows:

Command Action Comments
asleep() setThermostatProgram( 'Sleep' ) Must be one of programsList
auto() setThermostatMode( 'auto' ) Must be one of supportedThermostatModes
auxHeatOnly() setThermostatMode( 'auxHeatOnly' ) Turns on auxHeat (heat pump only)
awake() setThermostatProgram( 'Awake' ) Not all Ecobee thermostats have the program by default - you may need to create it manually
away() setThermostatProgram( 'Away' )
cancelReservation Internal use only
cancelVacation() Cancels the currently-active vacation hold
cool() setThermostatMode( 'cool' )
deleteVacation(vacationName) Cancels the specified vacation by name
doRefresh() Repaint the SmartThings-based UI data
emergency() setThermostatMode( 'auxHeatOnly' )
emergencyHeat() setThermostatMode( 'auxHeatOnly' )
fanAuto() setThermostatFanMode( 'auto' )
fanCirculate() setThermostatFanMode( 'circulate' )
fanOff() setThermostatFanMode( 'off' )
fanOn() setThermostatFanMode( 'on' )
forceRefresh() Force refresh ALL thermostat data from the Ecobee Cloud
generateEvent INTERNAL USE ONLY
heat() setThermostatMode( 'heat' )
home() setThermostatProgram( 'Home' )
lowerSetpoint() Lowers the thermostatSetpoint by 1°F or 0.5°C each call
makeReservation INTERNAL USE ONLY
night() setThermostatProgram( 'Sleep' )
noOp() INTERNAL USE ONLY
off() setThermostatMode( 'off' )
ping INTERNAL USE ONLY
present() setThermostatProgram( 'Home' ) For Nest compatibility
raiseSetpoint() Raises the thermostatSetpoint by 1°F or 0.5°C
refresh() Repaint the SmartThings-based UI data
resumeProgram() Cancels all Holds and returns to the regularly scheduled program
setCoolingSetpoint(setpoint) There is a 2+ second delay before the setpoint is changed
setCoolingSetpointDelay INTERNAL USE ONLY
setDehumidifierMode(mode) Mode must be one of supportedDehumidifierModes
setDehumiditySetpoint(setpoint) 35-100 - lower values have special meaning (trial and error)
setEcobeeSetting(name, value)
setFanMinOnTime(minutes)
setFanSpeed(speed) Must be one of fanSpeedOptions
setFanMinOnTimeDelay INTERNAL USE ONLY
setHeatingSetpoint(setpoint) There us a 2+ second delay before the setpoint is changed
setHeatingSetpointDelay INTERNAL USE ONLY
setHumidifierMode(mode) Mode must be one of supportedHumidifierModes
setHumiditySetpoint(setpoint) 35-100 - lower value have special meaning '(trial and error)
setProgramSetpoints(program, heatSetpoint, coolSetpoint)
setSchedule(program) Program must be one of programsList
setThermostatFanMode(mode) Mode must be one of supportedThermostatFanModes
setThermostatMode(mode) Mode must be one of supportedThermostatModes
setThermostatProgram(program) Program must be one of programsList
setVacationFanMinOnTime(minutes)
wakeup() setThermostatProgram( 'Wakeup' ) Not all Ecobee thermostats have the program by default - you may need to create it manually

Ecobee Suite Sensor Commands

Here is the comprehensive list of API commands available for Ecobee Sensor Devices. Notice that all of the add/delete/remove commands ultimately call updateSensorPrograms() which will atomically update all of the Programs this ES Sensor is enrolled and not-enrolled with a single call.

Command Action Comments
addSensorToAway(),
addSensorToHome(),
addSensorToSleep()		 updateSensorPrograms(["Away"], []) Adds (enrolls) this sensor the to referenced Program on its parent thermostat
addSensorToProgram(String program) updateSensorPrograms(["${program}"], []) Adds (enrolls) this sensor to the specified program
addSensorToPrograms(List programs) updateSensorPrograms(programs, []) Adds (enrolls) this sensor to the specified List of programs
deleteSensorFromAway(),
deleteSensorFromHome(),
deleteSensorFromSleep()		 updateSensorPrograms([], ["Home"]) Deletes (unenrolls) this sensor from the referenced Program
deleteSensorFromProgram (String program) updateSensorPrograms([],["${program}"]) Deletes (unenrolls) this sensor from the specified program
deleteSensorFromPrograms (List programs) updateSensorPrograms([], programs) Deletes (unenrolls) this sensor from the specified List of programs
disableSmartRoom() Disables the Smart Room status for this Sensor ("room")
doRefresh()
enableSmartRoom() Enables the Smart Room status for this Sensor ("room")
removeSensorFromAway(),
removeSensorFromHome(),
removeSensorFromSleep()		 updateSensorPrograms([], ["Home"]) Deletes (unenrolls) this sensor from the referenced program
removeSensorFromProgram (String program) updateSensorPrograms([],["${program}"]) Removes (unenrolls) this sensor from the specified program
removeSensorFromPrograms (List programs) updateSensorPrograms([],programs) Removes (unenrolls) this sensor from the specified List of programs
updateSensorPrograms(List addPrograms, List deletePrograms) The ultimate workhorse for changing Sensor enrollment in Thermostat Programs

Changing Programs (aka Schedules, aka Climates, aka Custom Comfort Profiles)

Calling any of the above will initiate a Hold for the requested program for the currently specified duration (Permanent, Until I Change, 2 Hours, 4 Hours, etc.). If the duration is Until I Change (temporary) and the requested program is the same as the current program, resumeProgram is effected instead to return to the scheduled program.

Changing Schedules

N.B. "schedule" is a synonymn for "programs". SmartThings has defined schedule/setSchedule is the API mechanism to change programs on a thermostst. Note that setSchedule() is a front-end for the existing setThermostatProgram() and resumeProgram() command entry points, as documented above.

Follows is documentation on the implementation within Ecobee Suite:

Using the new setSchedule(JSON_OBJECT)

The choice by SmartThings to define the argument to setSchedule() has allowed me to implement an incredibly flexible way to utilize this command to change the current program. The single argument passed can be a String (e.g., "Home"), or a List (e.g., ["Away", "nextTransition']) or a Map (e.g., [name: "Sleep", holdType: "holdHours", holdHours: 6]).

These arguments can be passed programmatically as their respective data types (String, List, or Map). But to make this implementation even more powerful, it allows you to pass a String that looks like JSON, but isn't necessarily pure JSON. In this manner, virtually ANY programming interface/language can be used to change the currently running program/schedule. For example:

| String Argument| Translates to | |---|---| |"Home"|[name: "Home"]| |"[Home]"|[name: "Home"]| |"Home,nextTransition"|[name: "Home", holdType: "nextTransition"]| |"name:Home,holdType:holdHours,holdHours:6"|[name: "Home", holdType: "holdHours", holdHours: 6]| |"name,Home,holdType,holdHours,holdHours,6"|[name: "Home", holdType: "holdHours", holdHours: 6]|

As the second example implies, the argument String can be wrapped in one or more pairs of brackets ("[...]") or even braces ("{...}").

This design provides ultimate flexibility for programmers and end users alike, and allows Hubitat+HubConnect users of the reflected Ecobee Suite Thermostat device to pass simple strings without sacrificing functionality.

About the new schedule Attribute

Since HubConnect doesn't reflect ALL of the attributes provided by the Ecobee Suite Thermostat device, I have chosen to somewhat overload the meaning of the schedule attribute. Under normal operation, it will merely report the current Program Name (Home, Away, Sleep...). But during a Hold event (or an Auto Home/Away event), the content will expand to be more descriptive, as in Hold Home until 6:30pm or Hold Away forever. SmartThings users get this additional information from the currentProgramName and statusMsg attributes which are displayed in the SmartThings Classic UI.

Changing Thermostat Modes

Changing Fan Operating Modes

Complex Commands Requiring Arguments

The following command entry points require multiple arguments, and so are most optimally utilized by SmartApps that can construct the required arguments, including WebCoRE (link-to-example-here). If you want to try using them, I suggest you review the DTH code directly to understand the required argument structure.

Using the ***Updated Attributes

Version 1.8.00 introduced several new "Updated" attributes. These are thermostat date/time stamps of when the associated internal data structures where most recently updated, see [Ecobee API Objects Documentation](https://www.ecobee.com/home/developer/api/documentation/v1/objects/Thermostat.shtml for more information)

These are provided as a means of knowing when complex thermostat operations have completed the round trip from the calling application, to the Ecobee servers, and then into the data returned by the Ecobee API. They are currently used by several of the ES Helpers that update the complex program.climates data structure. Combined with the Reservations system to enable synchronization across applications that modify Climates.

For example, changing a Programs heating/cooling setpoints requires changes to internal data structures that are otherwise opaque - there is no event generated once the call is complete. Applications wishing to change these setpoints may choose to subscribe to changes to the thermostat's climatesUpdated attribute to confirm that the most recent changes have been reflected in the API.

ES Thermostat ***Updated Attributes

ES Thermostat devices support the following ***Updated timestamps/events:

ES Sensor ***Updated Attributes

In most cases, the use case will warrant using only the Thermostat's Updated attributes, so as to be aware of changes being made by any of the underlying ES Sensors. However, you may also watch ES Sensor attributes the following subset of ES Sensor Updated events:

Reservations

Version 1.6.00 introduced a new internal use only Reservations System to the Suite. While this may one day be opened to external SmartApps or WeBCoRE pistons, for now it is a closed system.

To satisfy your curiosity:

The design intent is to enable certain types of coordination between the various Helper SmartApps. For example, if the Smart Mode helper decides to turn off the HVAC system (setting the thermostatMode to 'off'), then we probably don't want the Switches & Contacts helper turning the HVAC back on.

To accomplish this, Smart Mode will create a 'modeOff' reservation with each configured thermostat, signifying that it has interest in keeping the HVAC system turned off. Should the Contacts & Switches Helper also decide that the HVAC system should be turned off, it too takes out a' 'modeOff' reservation.

Given multiple such 'modeOff' reservations, neither Helper will turn the HVAC back on until ALL of the reservations are removed.

Operationally, reservations work much like semaphores. A process wishing to turn off the HVAC should (in pseudo-code):

  1. makeReservation(stat.Id, app.Id, 'modeOff')
  2. stat.off()

And when it wants to turn the HVAC back on:

  1. if ((reservationCount - myReservation) == 0) // No reservations except my own
  2. stat.auto()
  3. cancelReservation(stat.id, app.id, 'modeOff')

This order is important, because the entire Hubitat world is asynchronous. You want to be sure to grab the reservation before you turn off the device, and then you want to wait until you have turned the device back on AFTER you turn it on.

[Note: the revised implementation of Reservations in v1.6.10 and later uses atomicState variables to hold the reservations, explicitly to minimize race conditions. That said, I'm sure that they can still occur.]

The Reservation System implements the following commands/entry points:

Where:

Demand Response

In cooperation with power companies in some countries (including the USA), Ecobee thermostats can be requested to perform energy-saving demandResponse actions by the power companies (usually only if you register/subscribe to the program, often with a cash incentive). This version of Ecobee Suite adds support for recognizing, reporting these demandResponse activities.

These activities can take many forms, and so far I have only added support for the ones that I have experienced recently. First, there is a "pre-cool" request sent by the power company, usually to drop the coolingSetpoint (or increase the heatingSetpoint) between 3-5°F for 1.5 hours prior to sending the reduced power request. This latter demandRequest event will raise the current coolingSetpoint (or lower the heatingSetpoint by 4-5°F for a period of time (typ. 3-5 hours). These two events are reported slightly differently so that you can tell the difference:

It is important to understand that DR events CAN be overridden by another user-generated hold, but the end time of such a hold will be forced by Ecobee to match the end-time of the DR event. DR events are also created on top of any current hold, and the existing hold will be returned to after the DR event completes, or if it is cancelled. Also, you can turn off the HVAC altogether while a DR event is running, but it will not be automatically turned back on when the event finishes.

Developers should note that if they call resumeProgram() instead of cancelDemandResponse(), both the DR event AND any prior-existing Hold will be cancelled, and the regularly scheduled program will run. Also, it is not possible for end-users to create their own DR events (but you can create a Hold or a program that does the equivalent).

Hopefully the above provides enough info for WebCoRE users and Groovy programmers can interact with these DR events. If not, let me know.

This feature was added at user request. One person asked to be able to automatically cancel such events if they are at home; another wanted to take other energy-savings actions during a DR event (which often are scheduled when power rates are at their daily highest).

Finally, note that this is my first implementation - there undoubtedly will arise situations that I don't handle properly. If you find one, please let me know so I can increase the robustness of the implementation.