yracine / Device Type.myecobee
Programming Languages
Labels
Projects that are alternatives of or similar to Device Type.myecobee
device-type.myecobee Ecobee-SmartThings integration
*** The devices can be created using the Samsung connect app ****
My Ecobee Device: Custom ecobee device to enable more smart thermostat's capabilities within SmartThings
Author: Yves Racine
linkedIn profile: ca.linkedin.com/pub/yves-racine-m-sc-a/0/406/4b/
Date: 2014-03-31
For more details on the extensive features & capabilities of MyEcobee device, please refer to this ST community thread:
It's the most comprehensive ecobee integration under the ST platform.
please take note of the following statement:
For SmartTHings users, you can now download the code at
http://www.ecomatiqhomes.com/storeFor Hubitat users, you can now download the code at
http://www.ecomatiqhomes.com/hubitatstoreP.S. Technical support packages are also available.
Setup time: about 5-10 minutes depending on your ST skills.
PREREQUISITES
-
(a) Your ecobee thermostat fully operational (and connected to wifi)
-
(b) Your ecobee credentials (username/password)
-
(c) Developer access to SmartThings (http://graph.api.smartthings.com/)
-
(d) The installation may now proceed with the new Samsung connect app.
-
(e) Determine your shard, please consult this thread:
Or the SmartThings documentation here for more details:
http://docs.smartthings.com/en/latest/publishing/index.html#ensure-proper-location
If you are on a different shard, you need to change the links below for your right shard. As an example, in North America,
replace https://graph.api.smartthings.com/ide/devices by https://graph-na02-useast1.api.smartthings.com
Or use https://account.smartthings.com to point to the right shard (automatically).
- (f) To avoid confusion, remove EcobeeConnect or any other ecobee implementation
If you have installed EcobeeConnect before (stock ST device), remove the smartapp and related device(s) to avoid any confusion with My Ecobee Device. Both devices can run in parallel as they are totally distinct in their design & implementation.
INSTALLATION STEPS
1a) Create a new device Handler (My Ecobee Device)
a) Go to https://graph.api.smartthings.com/ide/devices (or whatever your shard is and click on My Device Handlers in the IDE's top menu)
b) Hit the "+New Device Handler" at the top right corner
c) Hit the "From Code" tab on the left corner
d) Copy and paste the code from the corresponding txt file in the zip
The code has been sent to you via your paypal verified email address.
e) Hit the create button at the bottom
f) Hit the "publish/for me" button at the top right corner (in the code window)
1b) (Optional) Create a new device Handler (My Ecobee Switch, If you have such switches at home)
N.B. The code for the new EcobeeSwitch+ is included in My Ecobee bundle only (available at my store).
a) Go to https://graph.api.smartthings.com/ide/devices (or whatever your shard is and click on My Device Handlers in the IDE's top menu)
b) Hit the "+New Device Handler" at the top right corner
c) Hit the "From Code" tab on the left corner
d) Copy and paste the code from the corresponding txt file in the zip
The code has been sent to you via your paypal verified email address.
e) Hit the create button at the bottom
f) Hit the "publish/for me" button at the top right corner (in the code window)
2) Create a new smartapp (My ecobee Init)
a) Go to https://graph.api.smartthings.com/ide/apps (or whatever your shard is and click on My Smartapps in the IDE's top menu)
b) Hit the "+New SmartApp" at the top right corner
c) Hit the "From Code" tab on the left corner
d) Copy and paste the code from the corresponding txt file in the zip
The code has been sent to you via your paypal verified email address.
e) Hit the create button at the bottom
f) Make sure that "enable OAuth" in Smartapp is active
- Goto app settings (top right corner, click on it)
- Click on Oauth (middle of the page), and enable OAuth in Smart app
- Hit "Update" at the bottom
g) Go back to the code window, and hit the "publish/for me" button at the top right corner
If the instructions above are not clear enough, you can refer to the troubleshooting section below with some pictures:
3) Under the new Samsung connect app, execute MyEcobeeInit (under + in the upper right corner/Smartapp)
Click on the Smartapp name (MyEcobeeInit) in the list of smartapps under the Custom section
4) Connect Smartthings to the Ecobee portal
You should already have an ecobee username and password, if not go to https://www.ecobee.com/home/ecobeeLogin.jsp
Go through the authentication process using MyEcobeeInit. To do so, please press on the "ecobee Connect> Required" button in the middle of the screen.
If needed, watch "how to setup ecobee" video (but use My ecobee Init instead of the Smarttings labs script) as the authentication process is similar.
http://blog.smartthings.com/news/smartthings-updates/new-additions-to-smartthings-labs
After signing-in, you need to accept the permission needed to connect your ecobee devices to SmartThings by pressing the accept button at the bottom of the page.
After being connected, click 'Next' and select your ecobee thermostat(s) (SmartThermostat, ecobee lite, ecobee3, SMART, SMART-SI) that you want to control from Smartthings and, then press 'Next' for the 'Other Settings &Notification' page, and then 'Done' or 'Save' when finished.
If you have My Ecobee bundle, you can also select your ecobee switch(es) to be exposed to ST.
N.B. If you have any errors:
If you get a blank screen after pressing 'Next or you get the following error: "Error - bad state' or 'Java.lang.NullPointerException: Cannot get property 'accessToken' on null object" in the IDE', you'd need to enable oAuth as specified in step 2f) above.
At the end of the authorization flow, if you have the following error message: "Unexpected error" even if you press several times, this probably means that you have not "saved & published" one of the Device Handler Types (MyEcobeeDevice,MyEcobeeSwitch) under the right shard. Refer to the prerequisites & step 1 for more details.
Also, depending on the ST platform status, you may have to press "Save" several times if you have the following error message: "Error processing your request - please try again". This is due to some ST platform timeouts due to rate limiting.
5) Your device(s) should now be ready to process your commands
Afer about 1 minute, You should see your device under:
https://graph.api.smartthings.com/device/list (or whatever your shard is and click on My Devices in the IDE's top menu)
And
In the new Samsung connect app, under the devices in the 'No room assigned' section (bottom of the page)
6) To populate the UI fields for your newly created device(s)
If needed, you may have to hit the My Ecobee device 'refresh' button several times as the smartThings app is not always responsive. You may want to stop and restart your smartthings app if needed.
7) (Optional) Set device's preferences
a) Go to https://graph.api.smartthings.com/device/list (or whatever your shard is and click on My Devices in the IDE's top menu)
b) Click on the My ecobee device that you just created
c) Click on Preferences (edit)
You only need to edit the following parameters
(a) <trace> when needed, set to true to get more tracing (no spaces)
(b) <holdType> set to nextTransition or indefinite (by default, no spaces)
(c) <logFilter:1..5> Values=[Level 1=ERROR only,2=<Level 1+WARNING>,3=<2+INFO>,4=<3+DEBUG>,5=<4+TRACE>]
P.S. Don't enter any values for the thermostat's serial number or for the appKey as the values are only
used for the PIN authentication method (not with the Service Manager). If you do it, you may
experience authentication issues when used with MyEcobeeInit smartapp.
For more details on the holdType input parameter, refer to the ST community wiki:
8) Use some of the Smartapps available (optional)
Some complimentary smartapps at my github, refer to:
https://github.com/yracine/device-type.myecobee/tree/master/smartapps
Amongst others:
/****************************************************
a) ecobee3RemoteSensorInit
/****************************************************
This smartapp will expose your ecobee3's remote sensors as Motion and Temperature Sensors in SmartThings, so that you can use them in your automation scenarios.
See the following readme file for instructions
https://github.com/yracine/device-type.myecobee/blob/master/smartapps/ecobeeRemoteSensor.md
/****************************************************
b) Monitor And Set Ecobee Temp
/****************************************************
In brief, the smartapp allows automatic adjustments of your programmed cooling/heating setpoints according to indoor/outdoor conditions. This is particularly useful in Winter/Summer where outdoor temperature and humidity can vary throughout the day. It can also set your thermostat to 'Away' or 'Home' based on your indoor motion sensors. It will ajust your thermostat's programmed or scheduled setpoints based on occupied rooms (similar to ecobee3, but with ST connected sensors).
You can enable/disable the smartapp with a button on/off tile (ex.virtual switch).
The smartapp can use an outdoor sensor or a virtual weather station, such as
https://github.com/yracine/device-type.weatherstation
to get the oudoor temperature and humidity.
/****************************************************
c) Monitor And Set Ecobee Humidity
/****************************************************
Monitor humidity level indoor vs. outdoor at regular intervals (in minutes) and set the humidifier/dehumidifier/HRV/ERV to a target humidity level.
P.S. Your humidifier/dehumidifier/HRV/ERV needs to be physically connected to ecobee.
/****************************************************
d) ecobeeChangeMode
/****************************************************
Change your ecobee climate (Away,Home) according to your hello home mode.
/****************************************************
e) ecobeeGetTips and EcobeeGenerateXXXstats/b>
/****************************************************
The smartapps allow the user to get comfort & energy tips based on his/her indoor/outdoor conditions at home. The ecobeeGenerateXXXstats smartapps allow to collect runtime stats for better tips generation.
/****************************************************
f) AwayFromHome and ecobeeResumeProg
/****************************************************
Use presence/motion sensors or ST hello modes to set a target climate or heating/cooling setpoints based on your presence/absence.
/****************************************************
g) ecobeeSetClimate
/****************************************************
This smartapp allows a ST user to set the ecobee thermostat(s) to a given climate (Away,Home,Awake,Sleep, other custom programs) at a given day&time.
/****************************************************
h) ecobeeStateTriggerHA
/****************************************************
The above smartapp allows a ST user to trigger some switch(es) (turn on/off or flash) and/or trigger a hello phrase routine when the thermostat is cooling/heating/running the fan/or idle.
/****************************************************
i) ecobeeSetZoneWithSchedule
/****************************************************
The smartapp that enables Multi Zoned Heating/Cooling Solutions based on your ecobee schedule(s)- coupled with smart vents (optional) for better temp settings control throughout your home"
And many others...