260 lines
13 KiB
HTML
260 lines
13 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>Input Text - Home Assistant</title>
|
|
<meta name="author" content="Home Assistant">
|
|
<meta name="description" content="Instructions how to integrate the Input Text component into Home Assistant.">
|
|
<meta name="viewport" content="width=device-width">
|
|
<link rel="canonical" href="https://home-assistant.io/components/input_text/">
|
|
<meta property="fb:app_id" content="338291289691179">
|
|
<meta property="og:title" content="Input Text">
|
|
<meta property="og:site_name" content="Home Assistant">
|
|
<meta property="og:url" content="https://home-assistant.io/components/input_text/">
|
|
<meta property="og:type" content="article">
|
|
<meta property="og:description" content="Instructions how to integrate the Input Text component 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="Input Text">
|
|
<meta name="twitter:description" content="Instructions how to integrate the Input Text component into 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">
|
|
Input Text
|
|
</h1>
|
|
</header>
|
|
<hr class="divider">
|
|
<p>The <code class="highlighter-rouge">input_text</code> component allows the user to define values that can be controlled via the frontend and can be used within conditions of automation. Changes to the value stored in the text box generate state events. These state events can be utilized as <code class="highlighter-rouge">automation</code> triggers as well.</p>
|
|
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entries</span>
|
|
<span class="s">input_text</span><span class="pi">:</span>
|
|
<span class="s">text1</span><span class="pi">:</span>
|
|
<span class="s">name</span><span class="pi">:</span> <span class="s">Text 1</span>
|
|
<span class="s">initial</span><span class="pi">:</span> <span class="s">Some Text</span>
|
|
<span class="s">text2</span><span class="pi">:</span>
|
|
<span class="s">name</span><span class="pi">:</span> <span class="s">Text 2</span>
|
|
<span class="s">min</span><span class="pi">:</span> <span class="s">8</span>
|
|
<span class="s">max</span><span class="pi">:</span> <span class="s">40</span>
|
|
<span class="s">text3</span><span class="pi">:</span>
|
|
<span class="s">name</span><span class="pi">:</span> <span class="s">Text 3</span>
|
|
<span class="s">pattern</span><span class="pi">:</span> <span class="s1">'</span><span class="s">[a-fA-F0-9]*'</span>
|
|
</code></pre>
|
|
</div>
|
|
<div class="config-vars">
|
|
<h3><a class="title-link" name="configuration-variables" href="#configuration-variables"></a> Configuration Variables</h3>
|
|
<dl class="">
|
|
<dt><a class="title-link" name="input_text" href="#input_text"></a> input_text</dt>
|
|
<dd>
|
|
<p class="desc"><span class="type">(<span class="map">map</span>)</span><span class="required">(Required)</span><span class="description">Alias for the input. Multiple entries are allowed.</span></p>
|
|
</dd>
|
|
<dd>
|
|
<dl class="nested">
|
|
<dt><a class="title-link" name="name" href="#name"></a> name</dt>
|
|
<dd>
|
|
<p class="desc"><span class="type">(<span class="string">String</span>)</span><span class="required">(Optional)</span><span class="description">Friendly name of the text input.</span></p>
|
|
</dd>
|
|
<dt><a class="title-link" name="min" href="#min"></a> min</dt>
|
|
<dd>
|
|
<p class="desc"><span class="type">(<span class="int">int</span>)</span><span class="required">(Optional)</span><span class="description">Minimum length for the text value.</span></p>
|
|
<p class="default">Default value: 0</p>
|
|
</dd>
|
|
<dt><a class="title-link" name="max" href="#max"></a> max</dt>
|
|
<dd>
|
|
<p class="desc"><span class="type">(<span class="int">int</span>)</span><span class="required">(Optional)</span><span class="description">Maximum length for the text value.</span></p>
|
|
<p class="default">Default value: 100</p>
|
|
</dd>
|
|
<dt><a class="title-link" name="initial" href="#initial"></a> initial</dt>
|
|
<dd>
|
|
<p class="desc"><span class="type">(<span class="string">String</span>)</span><span class="required">(Optional)</span><span class="description">Initial value when Home Assistant starts.</span></p>
|
|
<p class="default">Default value: empty</p>
|
|
</dd>
|
|
<dt><a class="title-link" name="pattern" href="#pattern"></a> pattern</dt>
|
|
<dd>
|
|
<p class="desc"><span class="type">(<span class="string">String</span>)</span><span class="required">(Optional)</span><span class="description">Regex pattern for client side validation.</span></p>
|
|
<p class="default">Default value: empty</p>
|
|
</dd>
|
|
</dl>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h3><a class="title-link" name="restore-state" href="#restore-state"></a> Restore State</h3>
|
|
<p>This component supports the <code class="highlighter-rouge">restore_state</code> function which restores the state after Home Assistant has started to the value it has been before Home Assistant stopped. To use this feature please make sure that the <a href="/components/recorder/"><code class="highlighter-rouge">recorder</code></a> component is enabled and your entity does not have a value set for <code class="highlighter-rouge">initial</code>. Additional information can be found in the <a href="/components/recorder/#restore-state">Restore state</a> section of the <a href="/components/recorder/"><code class="highlighter-rouge">recorder</code></a> component documentation.</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/input_text.markdown'>Edit this page on GitHub</a></div>
|
|
<div class='brand-logo-container section'>
|
|
<img src='/images/supported_brands/home-assistant.png' />
|
|
</div>
|
|
<div class='section'>
|
|
Introduced in release: 0.53
|
|
</div>
|
|
<div class='section'>
|
|
<h1 class="title delta">Category Automation</h1>
|
|
<ul class='divided'>
|
|
<li>
|
|
<a href='/components/alert/'>Alert</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/automation/'>Automation</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/counter/'>Counter</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/switch.flux/'>Flux Light Adjustment</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/hdmi_cec/'>HDMI CEC</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/ifttt/'>IFTTT</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/input_boolean/'>Input Boolean</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/input_datetime/'>Input Datetime</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/input_number/'>Input Number</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/input_select/'>Input Select</a>
|
|
</li>
|
|
<li>
|
|
Input Text
|
|
</li>
|
|
<li>
|
|
<a href='/components/keyboard/'>Keyboard</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/lirc/'>LIRC</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/device_sun_light_trigger/'>Presence based lights</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/proximity/'>Proximity</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/python_script/'>Python Scripts</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/rest_command/'>RESTful Command</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/script/'>Scripts</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/shell_command/'>Shell command</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/timer/'>Timer</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>
|