No announcement yet.

Ecobee Plug-in - User Guide

This topic is closed.
This is a sticky topic.
  • Filter
  • Time
  • Show
Clear All
new posts

    Ecobee Plug-in - User Guide


    System Requirements:
    This plugin is for HS3 or HS3PRO. On Windows it needs Microsoft .NET Framework 4.5 or higher. On Linux it needs mono 4.8 or higher.
    It is designed to interface HomeSeer with Ecobee Thermostats

    Plugin Installation:
    Download and install from the updater ("Thermostat / HVAC" section) or download package from the Beta Testing thread and follow instructions to install.

    Note: On Linux, if you have Mono.CSharp.dll and CSScriptLibrary.dll in the root HomeSeer folder you must move them to the bin folder. (This problem is already fixed on recent HS3 versions)

    sudo mv /usr/local/HomeSeer/Mono.CSharp.dll /usr/local/HomeSeer/bin/Mono.CSharp.dll
    sudo mv /usr/local/HomeSeer/CSScriptLibray.dll /usr/local/HomeSeer/bin/CSScriptLibrary.dll
    Plugin Configuration
    - Start the plugin from the "PLUG-INS > Manage" page, wait a few seconds for the plugin to initialize
    - go to the config page "PLUG-INS > Ecobee > Config" and click the "Ecobee Authorization" button, a code will be generated like in the screenshot below.

    Click image for larger version  Name:	authorization.jpg Views:	1 Size:	30.8 KB ID:	1266336

    - Log into your Ecobee account, then from the menu go to "MY APPS", click the "Add application" button and enter the code. Click Validate and you should get a page like the one below.

    Click image for larger version  Name:	authorization2.jpg Views:	1 Size:	54.2 KB ID:	1266337

    - Click Authorize then go back to the config page of the plugin and click the "Done" button.

    If everything is ok, the plugin is now authorized to access your Ecobee data, and will start to poll for changes every 4 minutes. Some Homeseer devices should have been created, go to the "VIEW > Device Management" page and check that your Ecobee devices are there

    Click image for larger version  Name:	devices.jpg Views:	1 Size:	99.7 KB ID:	1266338

    If you have some remote sensors associated with your Ecobee thermostat, one additional group of devices will be created for each sensor, like in the screenshot below:

    Click image for larger version

Name:	image_74141.png
Views:	1391
Size:	26.8 KB
ID:	1266335
    Last edited by spud; December 13, 2018, 08:00 AM.


    Once the devices are created their status/values are updated every 4 minutes with the actual data from your Ecobee thermostats.

    You can leverage this to trigger some events, for example when the ambient temperature goes above a specific value, or when the thermostat program switch to the Away mode, etc...
    Click image for larger version

Name:	ecobeetrigger.jpg
Views:	1
Size:	18.3 KB
ID:	1181055

    in a similar way you can use the devices that have controls (Current Programs, Target Temperatures, HVAC Mode, Fan Mode) to create event actions. For example you can create an event action to set the target temperature to a specific value:
    Click image for larger version

Name:	ecobeeaction.jpg
Views:	1
Size:	11.0 KB
ID:	1181056
    When you use the comfort settings controls (Home, Away, Sleep, etc..) from the "Current Program" device, or when you change the target temperatures, this will create a Hold Event on your Ecobee thermostat that last for the time specified as the "Hold Action For" setting in the config page. The possible values are 2 hours, 4 hours, Until the next scheduled activity, until I change it.

    There is also a specific Ecobee action that let you display some messages on your Ecobee Thermostats. That can be useful for notifications for example:
    Click image for larger version

Name:	messageaction.jpg
Views:	2
Size:	21.8 KB
ID:	1181057
    Click image for larger version

Name:	messagedisplay.jpg
Views:	2
Size:	32.8 KB
ID:	1181058
    Last edited by spud; January 24, 2016, 03:54 PM.



      The plugin natively integrates your thermostats in HSTouch. If you go to the climate section you will see all your thermostats, and you will be able to monitor and control them as shown in the screenshots below:

      Click image for larger version

Name:	hstouch.jpg
Views:	1
Size:	52.5 KB
ID:	1181059