jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions
home-assistant.github.io/components/google_assistant/index.html
Travis CI 233bcdc1d8 Site updated at 2017-11-05 14:24:39 UTC
2017-11-05 14:24:39 +00:00

281 lines
17 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>Google Assistant - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Setup for Google Assistant integration">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/google_assistant/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Google Assistant">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/google_assistant/">
<meta property="og:type" content="article">
<meta property="og:description" content="Setup for Google Assistant integration">
<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="Google Assistant">
<meta name="twitter:description" content="Setup for Google Assistant integration">
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
<link href="/stylesheets/screen.css" media="screen, projection, print" 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 class='site-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>
<li><a href='#' class='show-search'><i class="icon-search"></i></a></li>
</ul>
</nav>
<div class='search-container' style='display: none'>
<div class='search'>
<i class="icon-search"></i>
<input id='search' placeholder='Search the docs…'>
<a href='#' class='close'><i class="icon-remove-sign"></i></a>
</div>
</div>
</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">
Google Assistant
</h1>
</header>
<hr class="divider">
<h1>Google Assistant Docs</h1>
<p>The Google Assistant component requires a bit more setup than most due to the way Google requires Assistant Apps to be set up.</p>
<p class="note">
To use Google Assistant your Home Assistant configuration has to be externally accessible, with a hostname and SSL certificate. If you haven’t already configured that you should do so before continuing.
</p>
<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">google_assistant</span><span class="pi">:</span>
<span class="s">project_id</span><span class="pi">:</span> <span class="s">someproject-2d0b8</span>
<span class="s">client_id</span><span class="pi">:</span> <span class="pi">[</span><span class="nv">long URL safe random string</span><span class="pi">]</span>
<span class="s">access_token</span><span class="pi">:</span> <span class="pi">[</span><span class="nv">a different long URL safe random string</span><span class="pi">]</span>
<span class="s">exposed_domains</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">switch</span>
<span class="pi">-</span> <span class="s">light</span>
<span class="pi">-</span> <span class="s">group</span>
</code></pre>
</div>
<p><em>Note:</em> It’s very important that you use very long strings for <code class="highlighter-rouge">client_id</code> and <code class="highlighter-rouge">access_token</code>. Those are essentially the credentials to your Home Assistant instance. You can generate them with the following command:</p>
<p><code class="highlighter-rouge">cat /dev/urandom|fold -w 120|head -n 1|base64 -w 0|tr -dc '0-9A-Za-z'|cut -c -80</code></p>
<p><em>Configuration Variables:</em></p>
<ul>
<li><em>expose_by_default</em> (Optional): Expose devices in all supported domains by default.</li>
<li><em>project_id</em> (Required): Project ID from the Google Developer console (looks like <code class="highlighter-rouge">words-2ab12</code>)</li>
<li><em>client_id</em> (Required): A long random URL safe string (no spaces or special characters) that will be used for Implicit OAuth.</li>
<li><em>access_token</em> (Required): Another different long random URL safe string.</li>
<li><em>exposed_domains</em> (Optional): An array of Home Assistant domains to expose to Google Assistant. Options include:
<ul>
<li><code class="highlighter-rouge">switch</code></li>
<li><code class="highlighter-rouge">light</code></li>
<li><code class="highlighter-rouge">cover</code></li>
<li><code class="highlighter-rouge">media_player</code></li>
<li><code class="highlighter-rouge">group</code></li>
<li><code class="highlighter-rouge">fan</code></li>
<li><code class="highlighter-rouge">scene</code></li>
<li><code class="highlighter-rouge">script</code></li>
</ul>
</li>
</ul>
<p>You can also customize your devices similar to other components by adding keys to entities:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">homeassistant</span><span class="pi">:</span>
<span class="s">customize</span><span class="pi">:</span>
<span class="s">master_bedroom_light</span><span class="pi">:</span>
<span class="s">google_assistant</span><span class="pi">:</span> <span class="s">true</span>
<span class="s">google_assistant_name</span><span class="pi">:</span> <span class="s">bedroom light</span>
<span class="s">bedroom_blinds</span><span class="pi">:</span>
<span class="s">aliases</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">bedroom shades</span>
<span class="pi">-</span> <span class="s">bedroom covers</span>
<span class="s">hallway_ceiling_switch</span><span class="pi">:</span>
<span class="s">google_assistant</span><span class="pi">:</span> <span class="s">true</span>
<span class="s">google_assistant_type</span><span class="pi">:</span> <span class="s">light</span>
</code></pre>
</div>
<p><em>Entity Customization Keys:</em></p>
<ul>
<li><em>google_assistant</em>: True exposes entity, false will hide it</li>
<li><em>google_assistant_name</em>: Can be used to override the primary name of an entity. By default the <code class="highlighter-rouge">friendly_name</code> of an entity is used.</li>
<li><em>google_assistant_type</em>: Can be used to override the domain/type of an entity. For example a switch can be treated as a light</li>
<li><em>aliases</em>: Provides “nicknames” to Google Assistant. These function as alternate names for an entity that Assistant will understand when spoken.</li>
</ul>
<h3><a class="title-link" name="setup" href="#setup"></a> Setup</h3>
<ol>
<li>Install the <a href="https://developers.google.com/actions/tools/gactions-cli">gactions CLI</a> (you’ll use this later) - you can download this anywhere, just remember where you put it for later (and don’t forget to run <code class="highlighter-rouge">chmod +x gactions</code>)</li>
<li>Create a new file named <code class="highlighter-rouge">project.json</code> (in the same directory you downloaded <code class="highlighter-rouge">gactions</code> to) and replace the <code class="highlighter-rouge">[YOUR HOME ASSISTANT URL]</code> below with the URL you use to access Home Assistant.
Note: This must be an HTTPS URL to work.</li>
</ol>
<div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
</span><span class="nt">"actions"</span><span class="p">:</span><span class="w"> </span><span class="p">[{</span><span class="w">
</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"actions.devices"</span><span class="p">,</span><span class="w">
</span><span class="nt">"deviceControl"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="p">},</span><span class="w">
</span><span class="nt">"fulfillment"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nt">"conversationName"</span><span class="p">:</span><span class="w"> </span><span class="s2">"automation"</span><span class="w">
</span><span class="p">}</span><span class="w">
</span><span class="p">}],</span><span class="w">
</span><span class="nt">"conversations"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nt">"automation"</span><span class="w"> </span><span class="p">:</span><span class="w">
</span><span class="p">{</span><span class="w">
</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"automation"</span><span class="p">,</span><span class="w">
</span><span class="nt">"url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://[YOUR HOME ASSISTANT URL]/api/google_assistant"</span><span class="w">
</span><span class="p">}</span><span class="w">
</span><span class="p">}</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre>
</div>
<ol>
<li>Create a new project in the <a href="https://console.actions.google.com/">developer console</a>.
<ol>
<li>Add/Import project</li>
<li>Go to Build under the Actions SDK box</li>
<li>Copy the command that looks like:
<code class="highlighter-rouge">gactions update --action_package PACKAGE_NAME --project doctest-2d0b8</code></li>
</ol>
</li>
<li>Replace <code class="highlighter-rouge">PACKAGE_NAME</code> with <code class="highlighter-rouge">project.json</code> and run that command from the same directory you saved <code class="highlighter-rouge">project.json</code> in (you’ll need to put <code class="highlighter-rouge">./</code> before <code class="highlighter-rouge">gactions</code> so that it reads <code class="highlighter-rouge">./gactions</code>). It should output a URL like <code class="highlighter-rouge">https://console.actions.google.com/project/doctest-2d0b8/overview</code> - go there.</li>
<li>You’ll need to fill out most of the information on that page, but none of it really matters since you won’t be addressing the App directly, only through the Smart Home functionality built into Google Assistant.</li>
<li>The final item on that page <code class="highlighter-rouge">Account linking</code> is required for your app to interact with Home Assistant.
<ol>
<li>Grant type: <code class="highlighter-rouge">Implicit</code></li>
<li>Client ID: Should be the same as <code class="highlighter-rouge">client_id</code> from your hass config above</li>
<li>Authorization URL (replace with your actual URL): <code class="highlighter-rouge">https://[YOUR HOME ASSISTANT URL]/api/google_assistant/auth</code></li>
<li>Configure your client. Add scopes for <code class="highlighter-rouge">email</code> and <code class="highlighter-rouge">name</code></li>
<li>Testing instructions: doesn’t matter since you won’t submit this app</li>
</ol>
</li>
<li>Back on the main app draft page. Click <code class="highlighter-rouge">Test Draft</code>. That will take you to the simulator (which won’t work) so just close that window.</li>
<li>Open the Google Assistant app and go into <code class="highlighter-rouge">Settings &gt; Home Control</code></li>
<li>Click the <code class="highlighter-rouge">+</code> sign, and near the bottom, you should have <code class="highlighter-rouge">[test] your app name</code>. Selecting that should lead to you the screen where you can set rooms for your devices or nicknames for your devices.</li>
<li>If you want to allow other houshold users to control the devices:
<ol>
<li>Go to the developer console using address from point 4.</li>
<li>Under the gear icon, click <code class="highlighter-rouge">Permissions</code></li>
<li>Click <code class="highlighter-rouge">Add</code>, type the new user’s e-mail address and choose <code class="highlighter-rouge">Project -&gt; Editor</code> role</li>
<li>Have the new user go to <a href="https://console.actions.google.com/">developer console</a> and repeat steps starting from point 7.</li>
</ol>
</li>
</ol>
</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/google_assistant.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/google-assistant.png' />
</div>
<div class='section'>
Introduced in release: 0.56
</div>
<div class='section'>
<h1 class="title delta">Category Voice</h1>
<ul class='divided'>
<li>
<a href='/components/alexa/'>Alexa / Amazon Echo</a>
</li>
<li>
<a href='/components/conversation/'>Conversation</a>
</li>
<li>
<a href='/components/dialogflow/'>Dialogflow</a>
</li>
<li>
Google Assistant
</li>
<li>
<a href='/components/mycroft/'>Mycroft</a>
</li>
<li>
<a href='/components/snips/'>Snips</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>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.css" />
<script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script>
<script type="text/javascript">
docsearch({
apiKey: 'ae96d94b201c5444c8a443093edf3efb',
indexName: 'home-assistant',
inputSelector: '#search',
debug: false // Set debug to true if you want to inspect the dropdown
});
document.querySelector('.search .close').addEventListener('click', function(ev) {
ev.preventDefault();
document.querySelector('.search-container').style.display = 'none';
});
document.querySelector('.show-search').addEventListener('click', function(ev) {
ev.preventDefault();
document.querySelector('.search-container').style.display = 'block';
document.getElementById('toggle').checked = false;
document.querySelector('.search-container input').focus();
});
</script>
</body>
</html>
Reference in a new issue View git blame Copy permalink