My Ecobee Init

The Unofficial SmartThings Blog
Jump to: navigation, search
This smartapp isEcobee approved badge YVESR.png
ecobee3 Thermostat with Sensor, Wi-Fi, 2nd Generation, Works with Alexa

ecobee3 Thermostat with Sensor, Wi-Fi, 2nd Generation, Works with Alexa

Category: My Apps

Author:Yves Racine

ST Community handle: http://community.smartthings.com/users/yvesracine/activity

Company Link: http://www.ecomatiqhomes.com#!home/mainPage



If you like My Ecobee Device and related smartapps, please support the developer by clicking on the paypal link below:

https://paypal.me/ecomatiqhomes



Summary

My Ecobee Init, the smartapp that connects your Ecobee thermostat(s) to SmartThings via cloud-to-cloud integration (Service Manager).

Supported Features

  • All ecobee thermostat models are supported (ecobee4, lite, ecobee3, EMS, Smart-02, Smart-SI)
  • Multiple thermsostats can be selected to be exposed to SmartThings.
  • Do a poll at regular intervals (input parameter) to maintain the authorization with ecobee.
  • Notify you if there is any issue with the ST/ecobee connection (optional).
  • P.S. If you have more than 3 ecobee thermostats to be exposed, you can create multiple smartapp instances to avoid

ST rate limiting constraints.


Code location: http://github.com/yracine/device-type.myecobee/tree/master/smartapps

Instructions for installation (readme): https://github.com/yracine/device-type.myecobee/blob/master/README.md


Prerequisites

  • ecobee thermostat connected via wi-fi to ecobee (lite, ecobee4, ecobee3, Smart-SI, Smart, EMS)
  • SmartThings hub fully operational
  • Some ST basic skills to add custom DTH and smartapps (see troubleshooting section, item 1)
  • Use of the SmartThings classic mobile app for instantiation of the custom devices (only the basic attributes will display within the new Samsung Connect mobile app as ST is working on the required migration steps).

Troubleshooting

See troubleshooting section under My Ecobee Device

   http://thingsthataresmart.wiki/index.php?title=My_Ecobee_Device


.................................................................................................................................

Issue #1: I don't know how to create a custom smartapp

.................................................................................................................................

See the explanations of a fellow community member here:

http://community.smartthings.com/t/faq-an-overview-of-using-custom-code-in-smartthings/16772 http://thingsthataresmart.wiki/index.php?title=Using_Custom_Code

And, here are some basic explanations with screenshots.

  • Point your browser to you SmartThings IDE for your country (i.e. http://ide.smartthings.com or whatever your shard is, refer to the prerequisites at the readme) and Log In.

Loginscreen.jpg

  • Once you are logged in, find the My SmartApps link on the top of the page. Clicking My SmartApps will allow you to produce a new SmartApp.

MySmartApps.png

  • Find the button on this page labeled +New SmartApp and click it.

+NewSmartApp.png

  • Since you already have the code in your computer’s clipboard, find the tab along the top section called From Code. In the area provided, paste (typically CTRL+V) the code you copied from GitHub. Click Create in the bottom left corner of the page.

NewSmartAppCreate.png

  • This will bring up another page, with the code now formatted within the IDE. If the code was copied correctly, there are no other steps except to save and publish the code. In the upper right corner of the page, find and click Save. Now, click Publish (For Me), and you should receive a confirmation that the code has been published successfully.

SavePublish.png

To enable OAuth, first find and click the App Settings button in the upper right corner of the page.

From here, find the OAuth section toward the bottom of the page.

OAuthBtn.png

Clicking the OAuth link will reveal a button labeled Enable OAuth in Smart App. Click this button. The screen will change, giving you a unique code for your Client ID and Client Secret. These are the foundations of the security of your app and should be kept secret. You do not need to memorize or write down these codes; nor do you need to add any other information to this page. OAuth simply needs to be enabled for


OAuth.jpg .................................................................................................................................

Issue #2: I created the smartapp in the IDE, but I don't know where to execute it

.................................................................................................................................


For the initial setup, under the ST Classic mobile app, click on the Marketspace item in the bottom menu, and then, on the smartapps link and finally, MyApps (last item in the list).

If you still do not see your smartapp, please make sure that you have published it in the IDE!


For any subsequent execution, under the ST Classic mobile app, click on automations>smartapps in the bottom menu. The list of installed smartapps will then appear.


P.S. If you don't see your smartapp, it could be that you're not using the right shard for the installation. Refer to

https://community.smartthings.com/t/faq-how-to-find-out-what-shard-cloud-slice-ide-url-your-account-location-is-on/53923

Or the SmartThings documentation here:

http://docs.smartthings.com/en/latest/publishing/index.html#ensure-proper-location

.................................................................................................................................

Issue #3: java.lang.NullPointerException: Cannot get property 'X' on null object

.................................................................................................................................


Just update your smartapp by going through all the smartapp setup pages by pressing 'Next' till 'Done'.

The smartapp was recently modified to include some defensive code to ensure that the smartapp is rescheduled. This is intended to alleviate some of the ST scheduling issue as discussed in these threads:


http://community.smartthings.com/t/scheduler-and-polling-quits-after-some-minutes-hours-or-days/16997

http://community.smartthings.com/t/schedule-not-working/3895

http://community.smartthings.com/t/is-it-me-or-schedules-not-firing-this-evening/10176


.................................................................................................................................

Issue #4: Execution time exceeded 'x' app execution seconds

.................................................................................................................................

ST has introduced some generic rate limiting rules for all smartapps and device handlers. For cloud-to-cloud integrations, these rate limiting constraints are sometimes too low, and this exception can be raised from time to time.

There are some threads about it in the ST community forum:

http://community.smartthings.com/t/rate-limiting-too-restrictive-max-execution-time-exceptions/17985

http://community.smartthings.com/t/execution-times-increasing/19979

http://community.smartthings.com/t/unschedule-api-execution-time-too-long/11232

.................................................................................................................................

Issue #5: I want to upgrade the code but I don't know how

.................................................................................................................................

Most of the time (unless specified otherwise), you just need to copy and paste the smartapp's code from github (using the <raw> function preferrably to avoid forking the code for no reason) into the IDE at:


https://graph.api.smartthings.com/ide/apps

Click on the smartapp that you want to update

Paste the code into the code window (and make sure to copy all the lines)

And save & publish.


.................................................................................................................................

Issue #6: I have some scheduling issues and the smartapp is not rescheduled properly

.................................................................................................................................

There have been some serious ST scheduler issues for months, but it seems to be more prevalent now.

See this thread for more details about the ST scheduler issue:

https://community.smartthings.com/t/scheduler-and-polling-quits-after-some-minutes-hours-or-days/16997

Some workarounds have been implemented in my code to get around the scheduling issues.

You have 4 options available in the last page of the smartapp ("Other Options" under the "watchdogs" section):

(a)- The smartapp can subscribe to some temp sensor(s) for any change of values, and if so, reschedules the smartapp when values at the temp sensor are refreshed. By using some temp sensor(s) that regularly poll(s), this "heartbeat" is used to make sure that the smartapp is rescheduled when needed.

(b)- The smartapp can subscribe to some motion sensor(s) for any change of values, and if so, reschedules the smartapp when values at the motion sensor are refreshed. By using some motion sensor(s) that regularly poll(s), this "heartbeat" is used to make sure that the smartapp is rescheduled when needed.

(c)- The smartapp can subscribe to energy meter device for any change of values, and if so, reschedules the smartapp when energy values are refreshed. By using some energy meter(s) that regularly poll(s), this "heartbeat" is used to make sure that the smartapp is rescheduled when needed.

(d)- You'd can also used a (virtual or physical) switch in the smartapp and use Rule Machine to trigger the virtual/physical switch based on a timer.

To activate the subscriptions, you need to go through the smartapp's setup, press "Next" till the last Page (Other Options) and enter the new subscriptions indicated below:

   section("Watchdogs") {
       "What do I use as temperature sensor to restart smartapp processing?",type:"capability.temperatureMeasurement"
       "What do I use as a motion sensor to restart smartapp processing?",type:"capability.motionSensor"
       "What do I use as energy sensor to restart smartapp processing?",type:"capability.powerMeter"
       "What do I use as Master on/off switch to restart smartapp processing?",type:"capability.switch"
   }

In order to verify that the smartapp has been re-scheduled properly, follow the steps described below:

i) Go to https://graph.api.smartthings.com/location/list

ii) Click on list Smartapps

iii) Click on the smartapp to be checked

iv) Verify that the takeAction job is scheduled in the future (check the timestamp associated to the Next Run Time) under "Scheduled Jobs"

If it's not the case, you may want to re-execute the smartapp by pressing the arrow next to its name under My Home/Smartapps.

......................................................................................................................................

Issue #7: I want detailed Logging/Notifications or I want to enable Ask Alexa Notifications

......................................................................................................................................

In order to have detailed Logging/Notifications, you'd need to do the following:

  • a) Notifications & Other Settings Setup> On the last setup page, set the following flag to true
   "Detailed Logging & Notifications?"
  • b) Set the filtering level (ERROR, WARNING, DEBUG, TRACE): the TRACE level is the more detailed tracing you can get.
   "log filtering [Level 1=ERROR only,2=<Level 1+WARNING>,3=<2+INFO>,4=<3+DEBUG>,5=<4+TRACE>]?",required:false, metadata: [values: [1,2,3,4,5]]


  • c) To receive push notifications, answer 'Yes' to the following input parameter
   "Send a push notification?", metadata: [values: ["Yes", "No"]]


  • d) To receive the notifications configured above through Ask Alexa, set the following flag to true


   "Ask Alexa verbal Notifications?"


This way, you will get the same level of notifications (ERROR, WARNING, DEBUG,TRACE) verbally via the Ask Alexa smartapp.


.................................................................................................................................

Issue #8 - My new Ask Alexa's Message Queues are not showing up in the smartapp

.................................................................................................................................


You'd need to execute the MyEcobeeInit smartapp under Automation/Smartapps in the ST mobile app by doing "Next" till "Done" to subscribe to the new AskAlexaMQHandler. The new handler will then be able to process any Queue refresh value from Ask Alexa.


You can then go to the AskAlexa smartapp, and make any queue changes... The updated queue values will be then sent to the smartapp.

...............................................................................................................................

Issue #9: I cannot create any objects under the new Samsung app

.................................................................................................................................


No custom DTHs can be created under the new Samsung app for the moment as indicated in the prerequisites. You'd need to use the ST classic app to execute MyEcobeeInit in order to initially create My Ecobee devices. After creating the devices, follow the steps indicated in the installation pdf file included in the zip to force a refresh of the cache in order to make them appear correctly in the new Samsung app.


...............................................................................................................................

Issue #10: Some of my devices under the new Samsung app are disconnected

.................................................................................................................................


If some of your ecobee devices are disconnected under the new Samsung app, you may have created many of the same devices by executing MyEcobeeInit many times... Under the new Samsung mobile app, you then need to clean them up by pressing the "edit" button next to your location and removing them.