home-assistant.github.io/components/nest/index.html
2017-05-10 16:21:22 +00:00

336 lines
14 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!doctype html>
<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
<!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8"> <![endif]-->
<!--[if IE 8]> <html class="no-js lt-ie9"> <![endif]-->
<!--[if gt IE 8]><!--> <html> <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Nest - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to integrate Nest into Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/nest/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Nest">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/nest/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to integrate Nest into Home Assistant.">
<meta property="og:image" content="https://home-assistant.io/images/default-social.png">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:site" content="@home_assistant">
<meta name="twitter:title" content="Nest">
<meta name="twitter:description" content="Instructions how to integrate Nest into Home Assistant.">
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
<link href="/stylesheets/screen.css" media="screen, projection" rel="stylesheet">
<link href="/atom.xml" rel="alternate" title="Home Assistant" type="application/atom+xml">
<link rel='shortcut icon' href='/images/favicon.ico' />
<link rel='icon' type='image/png' href='/images/favicon-192x192.png' sizes='192x192' />
</head>
<body >
<header>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item three-tenths lap-two-sixths palm-one-whole ha-title">
<a href="/" class="site-title">
<img width='40' src='/demo/favicon-192x192.png'>
<span>Home Assistant</span>
</a>
</div>
<div class="grid__item seven-tenths lap-four-sixths palm-one-whole">
<nav>
<input type="checkbox" id="toggle">
<label for="toggle" class="toggle" data-open="Main Menu" data-close="Close Menu"></label>
<ul class="menu pull-right">
<li><a href="/getting-started/">Getting started</a></li>
<li><a href="/components/">Components</a></li>
<li><a href="/docs/">Docs</a></li>
<li><a href="/cookbook/">Examples</a></li>
<li><a href="/developers/">Developers</a></li>
<li><a href="/blog/">Blog</a></li>
<li><a href="/help/">Need help?</a></li>
</ul>
</nav>
</div>
</div>
</div>
</header>
<div class="grid-wrapper">
<div class="grid grid-center">
<div class="grid__item two-thirds lap-one-whole palm-one-whole">
<article class="page">
<header>
<h1 class="title indent">
Nest
</h1>
</header>
<hr class="divider">
<p>The Nest component is the main component to integrate all <a href="https://nest.com/">Nest</a> related platforms. To connect Nest, you will have to <a href="https://developers.nest.com/products">sign up for a developer account</a> and get a <code class="highlighter-rouge">client_id</code> and <code class="highlighter-rouge">client_secret</code>.</p>
<h3><a class="title-link" name="setting-up-developer-account" href="#setting-up-developer-account"></a> Setting up developer account</h3>
<ol>
<li>Visit <a href="https://developers.nest.com/">Nest Developers</a>, and sign in. Create an account if you dont have one already.</li>
<li>Fill in account details:
<ul>
<li>The “Company Information” can be anything. We recommend using your name.</li>
</ul>
</li>
<li>Submit changes</li>
<li>Click “<a href="https://developers.nest.com/products">Products</a>” at top of page.</li>
<li>Click “<a href="https://developers.nest.com/products/new">Create New Product</a></li>
<li>Fill in details:
<ul>
<li>Product name must be unique. We recommend [email] - Home Assistant.</li>
<li>The description, users, urls can all be anything you want.</li>
<li>Leave the “Redirect URI” Field blank</li>
</ul>
</li>
<li>For permissions check every box and if its an option select the read/write option.
<ul>
<li>The description requires a specific format to be accepted.</li>
<li>Use “[Home Assistant] [Edit] [For Home Automation]” as the description as it is not super important.</li>
</ul>
</li>
<li>Click “Create Product”</li>
<li>Once the new product page opens the “Product ID” and “Product Secret” are located on the right side. These will be used as <code class="highlighter-rouge">client_id</code> and <code class="highlighter-rouge">client_secret</code> below.</li>
<li>Once Home Assistant is started, a configurator will pop up asking you to log into your Nest account and copy a PIN code into Home Assistant.</li>
</ol>
<h3><a class="title-link" name="configuration" href="#configuration"></a> Configuration</h3>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">nest</span><span class="pi">:</span>
<span class="s">client_id</span><span class="pi">:</span> <span class="s">CLIENT_ID</span>
<span class="s">client_secret</span><span class="pi">:</span> <span class="s">CLIENT_SECRET</span>
</code></pre>
</div>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry to show only devices at your vacation and primary homes</span>
<span class="s">nest</span><span class="pi">:</span>
<span class="s">client_id</span><span class="pi">:</span> <span class="s">CLIENT_ID</span>
<span class="s">client_secret</span><span class="pi">:</span> <span class="s">CLIENT_SECRET</span>
<span class="s">structure</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">Vacation</span>
<span class="pi">-</span> <span class="s">Primary</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>client_id</strong> (<em>Required</em>): Your Nest developer client ID.</li>
<li><strong>client_secret</strong> (<em>Required</em>): Your Nest developer client secret.</li>
<li><strong>structure</strong> (<em>Optional</em>): The structure or structures you would like to include devices from. If not specified, this will include all structures in your Nest account.</li>
</ul>
</article>
</div>
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">
<div class="grid">
<section class="aside-module grid__item one-whole lap-one-half">
<div class='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_components/nest.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/nest.png' />
</div>
<div class='section'>
<h1 class='title delta'>Related components</h1>
<ul class='divided'>
<li><a href='/components/binary_sensor.nest/'>
Nest Binary Sensor
</a></li>
<li><a href='/components/camera.nest/'>
Nest Camera
</a></li>
<li><a href='/components/sensor.nest/'>
Nest Sensor
</a></li>
<li><a href='/components/climate.nest/'>
Nest Thermostat
</a></li>
</ul>
</div>
<div class='section'>
<h1 class="title delta">Category Hub</h1>
<ul class='divided'>
<li>
<a href='/components/apcupsd/'>APCUPSd</a>
</li>
<li>
<a href='/components/alarmdecoder/'>AlarmDecoder Alarm</a>
</li>
<li>
<a href='/components/android_ip_webcam/'>Android IP Webcam</a>
</li>
<li>
<a href='/components/wemo/'>Belkin WeMo</a>
</li>
<li>
<a href='/components/blink/'>Blink</a>
</li>
<li>
<a href='/components/bloomsky/'>BloomSky</a>
</li>
<li>
<a href='/components/digital_ocean/'>Digital Ocean</a>
</li>
<li>
<a href='/components/eight_sleep/'>Eight Sleep</a>
</li>
<li>
<a href='/components/emulated_hue/'>Emulated Hue Bridge</a>
</li>
<li>
<a href='/components/enocean/'>EnOcean</a>
</li>
<li>
<a href='/components/ffmpeg/'>FFmpeg</a>
</li>
<li>
<a href='/components/homematic/'>Homematic</a>
</li>
<li>
<a href='/components/tradfri/'>IKEA Trådfri (Tradfri)</a>
</li>
<li>
<a href='/components/isy994/'>ISY994 Controller</a>
</li>
<li>
<a href='/components/insteon_local/'>Insteon (local)</a>
</li>
<li>
<a href='/components/insteon_hub/'>Insteon Hub</a>
</li>
<li>
<a href='/components/insteon_plm/'>Insteon PLM</a>
</li>
<li>
<a href='/components/joaoapps_join/'>Joaoapps Join</a>
</li>
<li>
<a href='/components/litejet/'>LiteJet</a>
</li>
<li>
<a href='/components/lutron/'>Lutron</a>
</li>
<li>
<a href='/components/lutron_caseta/'>Lutron Caseta</a>
</li>
<li>
<a href='/components/mqtt/'>MQTT</a>
</li>
<li>
<a href='/components/microsoft_face/'>Microsoft Face</a>
</li>
<li>
<a href='/components/mochad/'>Mochad</a>
</li>
<li>
<a href='/components/modbus/'>Modbus</a>
</li>
<li>
<a href='/components/mysensors/'>MySensors</a>
</li>
<li>
<a href='/components/neato/'>Neato Robotics</a>
</li>
<li>
Nest
</li>
<li>
<a href='/components/netatmo/'>Netatmo</a>
</li>
<li>
<a href='/components/nuimo_controller/'>Nuimo controller</a>
</li>
<li>
<a href='/components/octoprint/'>OctoPrint</a>
</li>
<li>
<a href='/components/opencv/'>OpenCV</a>
</li>
<li>
<a href='/components/pilight/'>Pilight</a>
</li>
<li>
<a href='/components/qwikswitch/'>QwikSwitch QSUSB Hub</a>
</li>
<li>
<a href='/components/rflink/'>RFLink</a>
</li>
<li>
<a href='/components/rfxtrx/'>RFXtrx</a>
</li>
<li>
<a href='/components/ring/'>Ring</a>
</li>
<li>
<a href='/components/scsgate/'>SCSGate</a>
</li>
<li>
<a href='/components/sleepiq/'>SleepIQ</a>
</li>
<li>
<a href='/components/tado/'>Tado</a>
</li>
<li>
<a href='/components/tellstick/'>TellStick</a>
</li>
<li>
<a href='/components/tellduslive/'>Telldus Live</a>
</li>
<li>
<a href='/components/twilio/'>Twilio</a>
</li>
<li>
<a href='/components/vera/'>Vera</a>
</li>
<li>
<a href='/components/verisure/'>Verisure</a>
</li>
<li>
<a href='/components/volvooncall/'>Volvo On Call</a>
</li>
<li>
<a href='/components/wink/'>Wink</a>
</li>
<li>
<a href='/components/zwave/'>Z-Wave</a>
</li>
<li>
<a href='/components/zha/'>Zigbee Home Automation</a>
</li>
<li>
<a href='/components/zoneminder/'>ZoneMinder</a>
</li>
<li>
<a href='/components/ecobee/'>ecobee</a>
</li>
</ul>
</div>
</section>
</div>
</aside>
</div>
</div>
<footer>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item">
<div class="copyright">
<a rel="me" href='https://twitter.com/home_assistant'><i class="icon-twitter"></i></a>
<a rel="me" href='https://facebook.com/homeassistantio'><i class="icon-facebook"></i></a>
<a rel="me" href='https://plus.google.com/110560654828510104551'><i class="icon-google-plus"></i></a>
<a rel="me" href='https://github.com/home-assistant/home-assistant'><i class="icon-github"></i></a>
<div class="credit">
Contact us at <a href='mailto:hello@home-assistant.io'>hello@home-assistant.io</a> (no support!).<br>
Website powered by <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>.<br />
Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.
</div>
<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">home-assistant.io</span> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.
</div>
</div>
</div>
</div>
</footer>
<script>
var _gaq=[['_setAccount','UA-57927901-1'],['_trackPageview']];
(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
g.src=('https:'==location.protocol?'//ssl':'//www')+'.google-analytics.com/ga.js';
s.parentNode.insertBefore(g,s)}(document,'script'));
</script>
</body>
</html>