285 lines
15 KiB
HTML
285 lines
15 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>Amazon Polly - Home Assistant</title>
|
|
<meta name="author" content="Home Assistant">
|
|
<meta name="description" content="Instructions how to setup Amazon Polly with Home Assistant.">
|
|
<meta name="viewport" content="width=device-width">
|
|
<link rel="canonical" href="https://home-assistant.io/components/tts.amazon_polly/">
|
|
<meta property="fb:app_id" content="338291289691179">
|
|
<meta property="og:title" content="Amazon Polly">
|
|
<meta property="og:site_name" content="Home Assistant">
|
|
<meta property="og:url" content="https://home-assistant.io/components/tts.amazon_polly/">
|
|
<meta property="og:type" content="article">
|
|
<meta property="og:description" content="Instructions how to setup Amazon Polly 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="Amazon Polly">
|
|
<meta name="twitter:description" content="Instructions how to setup Amazon Polly with Home Assistant.">
|
|
<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">
|
|
Amazon Polly
|
|
</h1>
|
|
</header>
|
|
<hr class="divider">
|
|
<p>The <code class="highlighter-rouge">amazon_polly</code> text-to-speech platform that works with <a href="https://aws.amazon.com/polly/">Amazon Polly</a> to create the spoken output.
|
|
Polly is a paid service via Amazon Web Services. There is a <a href="https://aws.amazon.com/polly/pricing/">free tier</a> for the first 12 months and then a charge per million characters afterwards.</p>
|
|
<p>To get started, add the following lines to your <code class="highlighter-rouge">configuration.yaml</code> (example for Amazon Polly):</p>
|
|
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</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">amazon_polly</span>
|
|
<span class="s">aws_access_key_id</span><span class="pi">:</span> <span class="s">AWS_ACCESS_KEY_ID</span>
|
|
<span class="s">aws_secret_access_key</span><span class="pi">:</span> <span class="s">AWS_SECRET_ACCESS_KEY</span>
|
|
<span class="s">profile_name</span><span class="pi">:</span> <span class="s">AWS_PROFILE</span>
|
|
<span class="s">region_name</span><span class="pi">:</span> <span class="s1">'</span><span class="s">us-east-1'</span>
|
|
<span class="s">voice</span><span class="pi">:</span> <span class="s">Joanna</span>
|
|
</code></pre>
|
|
</div>
|
|
<p>Configuration variables:</p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Parameter</th>
|
|
<th>Value</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code class="highlighter-rouge">aws_access_key_id</code></td>
|
|
<td>Required</td>
|
|
<td>Your AWS Access Key ID. For more information, please read the <a href="http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html">AWS General Reference regarding Security Credentials</a>. If provided, you must also provide an <code class="highlighter-rouge">aws_secret_access_key</code> and must <strong>not</strong> provide a <code class="highlighter-rouge">profile_name</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code class="highlighter-rouge">aws_secret_access_key</code></td>
|
|
<td>Required</td>
|
|
<td>Your AWS Secret Access Key. For more information, please read the <a href="http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html">AWS General Reference regarding Security Credentials</a>. If provided, you must also provide an <code class="highlighter-rouge">aws_access_key_id</code> and must <strong>not</strong> provide a <code class="highlighter-rouge">profile_name</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code class="highlighter-rouge">profile_name</code></td>
|
|
<td>Optional</td>
|
|
<td>A credentials profile name. For more information, please see the <a href="http://boto3.readthedocs.io/en/latest/guide/configuration.html#shared-credentials-file">boto3 Documentation</a> for more information.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code class="highlighter-rouge">region_name</code></td>
|
|
<td>Optional</td>
|
|
<td>The region identifier to connect to. The default is <code class="highlighter-rouge">us-east-1</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code class="highlighter-rouge">name</code></td>
|
|
<td>Optional</td>
|
|
<td>Setting the optional parameter <code class="highlighter-rouge">name</code> allows multiple notifiers to be created. The default value is <code class="highlighter-rouge">notify</code>. The notifier will bind to the service <code class="highlighter-rouge">notify.NOTIFIER_NAME</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code class="highlighter-rouge">text_type</code></td>
|
|
<td>text/ssml</td>
|
|
<td>text or ssml: Specify wherever to use text (default) or ssml markup by default.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code class="highlighter-rouge">voice</code></td>
|
|
<td>Optional</td>
|
|
<td>Voice name to be used. See the <a href="http://docs.aws.amazon.com/polly/latest/dg/voicelist.html">Amazon Documentation</a> for available voices.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code class="highlighter-rouge">output_format</code></td>
|
|
<td>mp3/ogg_vorbis/pcm</td>
|
|
<td>Override the default output format, defaults to MP3.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code class="highlighter-rouge">sample_rate</code></td>
|
|
<td>8000/16000/22050</td>
|
|
<td>Override the default sample rate, defaults to 22050 for MP3 and Ogg Vorbis, 16000 for pcm.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2>Usage</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="pi">-</span> <span class="s">service</span><span class="pi">:</span> <span class="s">tts.amazon_polly_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"><speak>Hello</span><span class="nv"> </span><span class="s">from</span><span class="nv"> </span><span class="s">Amazon</span><span class="nv"> </span><span class="s">Polly</speak>'</span>
|
|
</code></pre>
|
|
</div>
|
|
<p>or</p>
|
|
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="pi">-</span> <span class="s">service</span><span class="pi">:</span> <span class="s">tts.amazon_polly_say</span>
|
|
<span class="s">data_template</span><span class="pi">:</span>
|
|
<span class="s">message</span><span class="pi">:</span> <span class="pi">></span>
|
|
<span class="no"><speak></span>
|
|
<span class="no">Hello from Amazon Polly</span>
|
|
<span class="no"></speak></span>
|
|
</code></pre>
|
|
</div>
|
|
<p>Say to the <code class="highlighter-rouge">media_player.living_room</code> device entity:</p>
|
|
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="pi">-</span> <span class="s">service</span><span class="pi">:</span> <span class="s">tts.amazon_polly_say</span>
|
|
<span class="s">data_template</span><span class="pi">:</span>
|
|
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">media_player.living_room</span>
|
|
<span class="s">message</span><span class="pi">:</span> <span class="pi">></span>
|
|
<span class="no"><speak></span>
|
|
<span class="no">Hello from Amazon Polly</span>
|
|
<span class="no"></speak></span>
|
|
</code></pre>
|
|
</div>
|
|
<p>Say with break:</p>
|
|
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="pi">-</span> <span class="s">service</span><span class="pi">:</span> <span class="s">tts.amazon_polly_say</span>
|
|
<span class="s">data_template</span><span class="pi">:</span>
|
|
<span class="s">message</span><span class="pi">:</span> <span class="pi">></span>
|
|
<span class="no"><speak></span>
|
|
<span class="no">Hello from</span>
|
|
<span class="no"><break time=".9s" /></span>
|
|
<span class="no">Amazon Polly</span>
|
|
<span class="no"></speak></span>
|
|
</code></pre>
|
|
</div>
|
|
</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.amazon_polly.markdown'>Edit this page on GitHub</a></div>
|
|
<div class='brand-logo-container section'>
|
|
<img src='/images/supported_brands/polly.png' />
|
|
</div>
|
|
<div class='section'>
|
|
Introduced in release: 0.37
|
|
</div>
|
|
<div class='section'>
|
|
Source:
|
|
<a href='https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/tts/amazon_polly.py'>tts/amazon_polly.py</a>
|
|
</div>
|
|
<div class='section'>
|
|
This is a platform for
|
|
<a href='/components/tts/'>the Text-to-Speech (TTS) component</a>.
|
|
</div>
|
|
<div class='section'>
|
|
<h1 class="title delta">Category Text-to-speech</h1>
|
|
<ul class='divided'>
|
|
<li>
|
|
Amazon Polly
|
|
</li>
|
|
<li>
|
|
<a href='/components/tts.baidu/'>Baidu Text-to-Speech</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/tts.google/'>Google Text-to-Speech</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/tts.marytts/'>MaryTTS</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/tts.microsoft/'>Microsoft 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>
|
|
</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>
|