261 lines
No EOL
12 KiB
HTML
261 lines
No EOL
12 KiB
HTML
<!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>Text-to-Speech (TTS) - Home Assistant</title>
|
|
<meta name="author" content="Home Assistant">
|
|
<meta name="description" content="Instructions how to setup Text-to-Speech (TTS) with Home Assistant.">
|
|
|
|
<meta name="viewport" content="width=device-width">
|
|
<link rel="canonical" href="https://home-assistant.io/components/tts/">
|
|
|
|
<meta property="fb:app_id" content="338291289691179">
|
|
<meta property="og:title" content="Text-to-Speech (TTS)">
|
|
<meta property="og:site_name" content="Home Assistant">
|
|
<meta property="og:url" content="https://home-assistant.io/components/tts/">
|
|
<meta property="og:type" content="article">
|
|
<meta property="og:description" content="Instructions how to setup Text-to-Speech (TTS) with 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="Text-to-Speech (TTS)">
|
|
<meta name="twitter:description" content="Instructions how to setup Text-to-Speech (TTS) with 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="/ecosystem/">Ecosystem</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">
|
|
Text-to-Speech (TTS)
|
|
</h1>
|
|
</header>
|
|
<hr class="divider">
|
|
|
|
|
|
<p>Text-to-speech (TTS) enables Home Assistant to speak to you.</p>
|
|
|
|
<h2><a class="title-link" name="configuring-a-tts-platform" href="#configuring-a-tts-platform"></a> Configuring a <code class="highlighter-rouge">tts</code> platform</h2>
|
|
|
|
<p>To get started, add the following lines to your <code class="highlighter-rouge">configuration.yaml</code> (example for google):</p>
|
|
|
|
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry for google tts service</span>
|
|
<span class="s">tts</span><span class="pi">:</span>
|
|
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">google</span>
|
|
</code></pre>
|
|
</div>
|
|
|
|
<p>The following optional parameters can be used with any platform. However the TTS component will only look for global settings under the configuration of the first configured platform:</p>
|
|
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Parameter</th>
|
|
<th>Default</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code class="highlighter-rouge">cache</code></td>
|
|
<td>True</td>
|
|
<td>Allow TTS to cache voice file to local storage.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code class="highlighter-rouge">cache_dir</code></td>
|
|
<td>tts</td>
|
|
<td>Foldername or path to folder for caching files.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code class="highlighter-rouge">time_memory</code></td>
|
|
<td>300</td>
|
|
<td>Time to hold the voice data inside memory for fast play on media player. Minimum is 60 s and the maximum 57600 s (16 hours).</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<p>The extended example from above would look like the following sample:</p>
|
|
|
|
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry for google tts service</span>
|
|
<span class="s">tts</span><span class="pi">:</span>
|
|
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">google</span>
|
|
<span class="s">cache</span><span class="pi">:</span> <span class="s">true</span>
|
|
<span class="s">cache_dir</span><span class="pi">:</span> <span class="s">/tmp/tts</span>
|
|
<span class="s">time_memory</span><span class="pi">:</span> <span class="s">300</span>
|
|
</code></pre>
|
|
</div>
|
|
|
|
<p class="note">
|
|
If you are running Home Assistant over SSL or from within a container, you will have to setup a base url inside the <a href="/components/http/">http component</a>.
|
|
</p>
|
|
|
|
<h2><a class="title-link" name="service-say" href="#service-say"></a> Service say</h2>
|
|
|
|
<p>Say to all <code class="highlighter-rouge">media_player</code> device entities:</p>
|
|
|
|
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Replace google_say with <platform>_say when you use a different platform.</span>
|
|
<span class="s">service</span><span class="pi">:</span> <span class="s">tts.google_say</span>
|
|
<span class="s">data</span><span class="pi">:</span>
|
|
<span class="s">message</span><span class="pi">:</span> <span class="s1">'</span><span class="s">May</span><span class="nv"> </span><span class="s">the</span><span class="nv"> </span><span class="s">Force</span><span class="nv"> </span><span class="s">be</span><span class="nv"> </span><span class="s">with</span><span class="nv"> </span><span class="s">you.'</span>
|
|
</code></pre>
|
|
</div>
|
|
<p>Say to the <code class="highlighter-rouge">media_player.floor</code> device entity:</p>
|
|
|
|
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">service</span><span class="pi">:</span> <span class="s">tts.google_say</span>
|
|
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">media_player.floor</span>
|
|
<span class="s">data</span><span class="pi">:</span>
|
|
<span class="s">message</span><span class="pi">:</span> <span class="s1">'</span><span class="s">May</span><span class="nv"> </span><span class="s">the</span><span class="nv"> </span><span class="s">Force</span><span class="nv"> </span><span class="s">be</span><span class="nv"> </span><span class="s">with</span><span class="nv"> </span><span class="s">you.'</span>
|
|
</code></pre>
|
|
</div>
|
|
|
|
<p>Say to the <code class="highlighter-rouge">media_player.floor</code> device entity in French:</p>
|
|
|
|
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">service</span><span class="pi">:</span> <span class="s">tts.google_say</span>
|
|
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">media_player.floor</span>
|
|
<span class="s">data</span><span class="pi">:</span>
|
|
<span class="s">message</span><span class="pi">:</span> <span class="s1">'</span><span class="s">Que</span><span class="nv"> </span><span class="s">la</span><span class="nv"> </span><span class="s">force</span><span class="nv"> </span><span class="s">soit</span><span class="nv"> </span><span class="s">avec</span><span class="nv"> </span><span class="s">toi.'</span>
|
|
<span class="s">language</span><span class="pi">:</span> <span class="s1">'</span><span class="s">fr'</span>
|
|
</code></pre>
|
|
</div>
|
|
|
|
<p>With a template:</p>
|
|
|
|
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">service</span><span class="pi">:</span> <span class="s">tts.google_say</span>
|
|
<span class="s">data_template</span><span class="pi">:</span>
|
|
<span class="s">message</span><span class="pi">:</span> <span class="s1">'</span><span class="s">Temperature</span><span class="nv"> </span><span class="s">is</span><span class="nv"> </span><span class="s">{{</span><span class="nv"> </span><span class="s">sensor.temperature</span><span class="nv"> </span><span class="s">}}.'</span>
|
|
<span class="s">cache</span><span class="pi">:</span> <span class="s">false</span>
|
|
</code></pre>
|
|
</div>
|
|
|
|
<h2><a class="title-link" name="cache" href="#cache"></a> Cache</h2>
|
|
|
|
<p>The component has two caches. Both caches can be controlled with the <code class="highlighter-rouge">cache</code> option in the platform configuration or the service call <code class="highlighter-rouge">say</code>. A long time cache will be located on the file system. The in-memory cache for fast responses to media players will be auto-cleaned after a short period.</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/tts.markdown'>Edit this page on GitHub</a></div>
|
|
<div class='brand-logo-container section'>
|
|
</div>
|
|
<div class='section'>
|
|
Introduced in release: 0.35
|
|
</div>
|
|
<h1 class='title delta'>Platforms</h1>
|
|
<ul class='divided'>
|
|
<li><a href='/components/tts.google/'>
|
|
Google Text-to-Speech
|
|
</a></li>
|
|
<li><a href='/components/tts.picotts/'>
|
|
Pico Text-to-Speech
|
|
</a></li>
|
|
<li><a href='/components/tts.voicerss/'>
|
|
VoiceRSS
|
|
</a></li>
|
|
<li><a href='/components/tts.yandextts/'>
|
|
Yandex TTS
|
|
</a></li>
|
|
</ul>
|
|
</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>.<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> |