jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Site updated at 2016-09-10 13:32:34 UTC

Browse source
This commit is contained in:
Travis CI 2016-09-10 13:32:34 +00:00
parent 60ccf38447
commit 8d13e105dc
53 changed files with 175 additions and 146 deletions
Download patch file Download diff file Expand all files Collapse all files

47
components/ecobee/index.html
View file

@ -7,7 +7,7 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Ecobee - Home Assistant</title>
<title>ecobee - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions for how to integrate Ecobee thermostats and sensors within Home Assistant.">
@ -15,7 +15,7 @@
<link rel="canonical" href="https://home-assistant.io/components/ecobee/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Ecobee">
<meta property="og:title" content="ecobee">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/ecobee/">
<meta property="og:type" content="article">
@ -25,7 +25,7 @@
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:site" content="@home_assistant">
<meta name="twitter:title" content="Ecobee">
<meta name="twitter:title" content="ecobee">
<meta name="twitter:description" content="Instructions for how to integrate Ecobee thermostats and sensors within Home Assistant.">
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
@ -91,9 +91,38 @@
<p>The <code class="highlighter-rouge">ecobee</code> component lets you control a thermostats and view sensor data from <a href="https://ecobee.com">ecobee</a> thermostats.</p>
<p>You will need to obtain an API key from ecobee’s <a href="https://www.ecobee.com/developers/">developer site</a> to use this component. To get the key, first you need to register your thermostat. Once you have done that, click on the <strong>Become a developer</strong> link on the developer site. Login with your Ecobee credentials, accept the SDK agreement, fill in the fields, and click <strong>save</strong>. Now login to the regular consumer portal, and in the hamburger menu there will be a new option <strong>Developer</strong>. Select that, then select <strong>Create New</strong>. Give your app a name (it appears to need to be unique across all users, as I tried ‘home-assistant’ and it said it was already in use) and a summary (neither of these are important as they are not used anywhere). For Authorization method select <strong>ecobee PIN</strong>. You don’t need an Application Icon or Detailed Description. Click <strong>Save</strong>. Now under the Name and Summary Section you will have an API key. Copy this key and use it in you configuration section below. Click the <strong>X</strong> to close the Developer section.</p>
<p>You will need to obtain an API key from ecobee’s <a href="https://www.ecobee.com/developers/">developer site</a> to use this component. To get the key, first you need to register your thermostat which should be done as part of the ecobee installation. Once you have done that perform the following steps.</p>
<p>The first time you run Home Assistant with this component it will give you a PIN code that you need to authorize in the <a href="https://www.ecobee.com/consumerportal/index.html">ecobee consumer portal</a>. You can do this by clicking <strong>Add Application</strong> in the <strong>My Apps</strong> section in the sidebar. Enter the PIN code from the Home Assistant screeen. To get the PIN code select the item in the ecobee card. If you do not have an ecobee card, you may be using groups with <code class="highlighter-rouge">default_view</code> that don’t show the card. To get around this you can temporarily comment out the <code class="highlighter-rouge">default_view</code> section or add the <code class="highlighter-rouge">configurator.ecobee</code> component to your <code class="highlighter-rouge">default_view</code> and restart Home Assistant. Once you enter the PIN on the ecobee site, wait approximately 5 minutes and then click on the <strong>I have authorized the app</strong> link at the bottom of the ecobee popup window. If everything worked correctly, you should now be able to restart Home Assistant again to see the full ecobee card with all of the sensors populated or see the list of sensors in the developer tools. Now you can re-enable your <code class="highlighter-rouge">default_view</code> (if you had to disable it) and add the ecobee sensors to a group and/or view.</p>
<ol>
<li>Click on the <strong>Become a developer</strong> link on the <a href="https://www.ecobee.com/developers/">developer site</a>.</li>
<li>Login with your ecobee credentials.</li>
<li>Accept the SDK agreement.</li>
<li>Fill in the fields.</li>
<li>Click <strong>save</strong>.</li>
</ol>
<p>Now login to the regular consumer portal, and in the hamburger menu there will be a new option <strong>Developer</strong>. Now we can create the Application to hook up to Home Assistant.</p>
<ol>
<li>Select the Developer option.</li>
<li>Select <strong>Create New</strong>.</li>
<li>Give your app a name (it appears to need to be unique across all users, as I tried ‘home-assistant’ and it said it was already in use. Try <yournameoralias>-home-assistant) and a summary (neither of these are important as they are not used anywhere).</yournameoralias></li>
<li>For Authorization method select <strong>ecobee PIN</strong>.</li>
<li>You don’t need an Application Icon or Detailed Description.</li>
<li>Click <strong>Save</strong>.</li>
</ol>
<p>Now under the Name and Summary Section you will have an API key. Copy this key and use it in you configuration section below. Click the <strong>X</strong> to close the Developer section.</p>
<p>The first time you run Home Assistant with this component it will give you a PIN code that you need to authorize in the <a href="https://www.ecobee.com/consumerportal/index.html">ecobee consumer portal</a>. You can do this by clicking <strong>Add Application</strong> in the <strong>My Apps</strong> section in the sidebar.</p>
<p>The PIN can be found from the Home Assistant portal on the Ecobee card or from the <strong>configurator.ecobee</strong> entity in states in the portal.</p>
<ul>
<li>If you do not have an ecobee card, you may be using groups with <code class="highlighter-rouge">default_view</code> that don’t show the card. To get around this you can temporarily comment out the <code class="highlighter-rouge">default_view</code> section or add the <code class="highlighter-rouge">configurator.ecobee</code> component to your <code class="highlighter-rouge">default_view</code> and restart Home Assistant.</li>
</ul>
<p>Once you enter the PIN on the ecobee site, wait approximately 5 minutes and then click on the <strong>I have authorized the app</strong> link at the bottom of the ecobee popup window. If everything worked correctly, you should now be able to restart Home Assistant again to see the full ecobee card with all of the sensors populated or see the list of sensors in the developer tools. Now you can re-enable your <code class="highlighter-rouge">default_view</code> (if you had to disable it) and add the ecobee sensors to a group and/or view.</p>
<p>To set it up, add the following information to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
@ -106,7 +135,7 @@
<p>Configuration variables:</p>
<ul>
<li><strong>api_key</strong> (<em>Required</em>): Your ecobee API key.</li>
<li><strong>api_key</strong> (<em>Required</em>): Your ecobee API key. This is only needed for the inital setup of the component. Once registered it can be removed. If you revoke the key in the ecobee portal you will need to update this again and remove the ecobee.conf file in the <code class="highlighter-rouge">.homeassistant</code> configuration path.</li>
<li><strong>hold_temp</strong> (<em>Optional</em>): True/False whether or not to hold changes indefinitely (True) or until the next scheduled event. Defaults to <code class="highlighter-rouge">False</code>.</li>
</ul>
@ -160,9 +189,6 @@
<li>
<a href='/components/bloomsky/'>BloomSky</a>
</li>
<li>
Ecobee
</li>
<li>
<a href='/components/emulated_hue/'>Emulated Hue Bridge</a>
</li>
@ -229,6 +255,9 @@
<li>
<a href='/components/zwave/'>Z-Wave</a>
</li>
<li>
ecobee
</li>
</ul>
</div>
</section>