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 1b94ba3d97 Site updated at 2017-12-24 13:57:33 UTC
2017-12-24 13:57:33 +00:00

307 lines
21 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">
<p>The <code class="highlighter-rouge">google_assistant</code> component allows you to control things via Google Assistant (on your mobile or tablet) or a Google Home device.</p>
<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>
<p>To enable this, add the following lines to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
<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">agent_user_id</span><span class="pi">:</span> <span class="pi">[</span><span class="nv">a string to identify user</span><span class="pi">]</span>
<span class="s">api_key</span><span class="pi">:</span> <span class="pi">[</span><span class="nv">an API Key generated for the Google Actions project</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>Configuration variables:</p>
<ul>
<li><strong>expose_by_default</strong> (<em>Optional</em>): Expose devices in all supported domains by default.</li>
<li><strong>project_id</strong> (<em>Required</em>): Project ID from the Google Developer console (looks like <code class="highlighter-rouge">words-2ab12</code>)</li>
<li><strong>client_id</strong> (<em>Required</em>): A long random URL safe string (no spaces or special characters) that will be used for Implicit OAuth.</li>
<li><strong>access_token</strong> (<em>Required</em>): Another different long random URL safe string.</li>
<li><strong>agent_user_id</strong> (<em>Optional</em>): A string to identify the user, e.g., email address. If not provided, the component will generate one.</li>
<li><strong>api_key</strong> (<em>Optional</em>): An API Key generated for the project from <a href="https://console.cloud.google.com/apis/api/homegraph.googleapis.com/overview">Google Console</a> which allows you to update devices without unlinking and relinking an account (see setup below). If not provided then the request_sync service is not exposed.</li>
<li><strong>exposed_domains</strong> (<em>Optional</em>): 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>
<li><code class="highlighter-rouge">climate</code></li>
</ul>
</li>
</ul>
<p>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>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>cat /dev/urandom | fold -w 120 | head -n 1 | base64 -w 0 | tr -dc <span class="s1">'0-9A-Za-z'</span> | cut -c -80
</code></pre>
</div>
<p>If you’re not using Linux, you can use sites such as <a href="https://www.browserling.com/tools/random-string">this one</a> to generate a random string (containing mixed case letters and numbers) of up to 80 characters.</p>
<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>Entity Customization Keys:</p>
<ul>
<li><strong>google_assistant</strong>: True exposes entity, false will hide it.</li>
<li><strong>google_assistant_name</strong>: 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><strong>google_assistant_type</strong>: Can be used to override the domain/type of an entity. For example a switch can be treated as a light</li>
<li><strong>aliases</strong>: 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> if you’re running on Linux). 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: The <code class="highlighter-rouge">client_id</code> from your Home Assistant configuration 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>
<li>If you want to use the <code class="highlighter-rouge">google_assistant.request_sync</code> service in Home Assistant, then enable Homegraph API for your project:
<ol>
<li>Go to the <a href="https://console.cloud.google.com/apis/api/homegraph.googleapis.com/overview">cloud console</a></li>
<li>Select your project and click Enable Homegraph API</li>
<li>Go to Credentials and select API Key from Create Credentials</li>
<li>Note down the generated API Key and use this in the configuration</li>
</ol>
</li>
</ol>
<p><em>Note:</em> The request_sync service requires that the initial sync from Google includes the agent_user_id. If not, the service will log an error that reads something like “Request contains an invalid argument”. If this happens, then <a href="https://support.google.com/googlehome/answer/7506443?hl=en-GB">unlink the account</a> from Home Control and relink.</p>
<p><em>Note:</em> The request_sync service may fail with a 404 if the project_id of the Homegraph API differs from the project_id of the Actions SDK found in the preferences of your project on <a href="https://console.actions.google.com">developer console</a>. Resolve this by:
1. Removing your project on the <a href="https://console.actions.google.com">developer console</a>.
2. Add a new project in the <a href="https://console.cloud.google.com">cloud console</a>. Here you get a new project_id.
3. Enable Homegraph API to the new project.
4. Generete a new API key.
5. Again create a new project in the <a href="https://console.actions.google.com/">developer console</a>. Described above. But at the step ‘Build under the Actions SDK box’ choose your newly created project. By this they share the same project_id.</p>
</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/cloud/'>Cloud</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