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

243 lines
12 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>Input Datetime - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to integrate the Input Datetime component into Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/input_datetime/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Input Datetime">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/input_datetime/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to integrate the Input Datetime 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 Datetime">
<meta name="twitter:description" content="Instructions how to integrate the Input Datetime 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 Datetime
</h1>
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">input_datetime</code> component allows the user to define date and time values that can be controlled via the frontend and can be used within automations and templates.</p>
<p>To add three datetime inputs to your installation, one with both date and time, and one with date or time each, add the following lines to your <code class="highlighter-rouge">configuration.yaml</code>:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">input_datetime</span><span class="pi">:</span>
<span class="s">both_date_and_time</span><span class="pi">:</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">Input with both date and time</span>
<span class="s">has_date</span><span class="pi">:</span> <span class="s">true</span>
<span class="s">has_time</span><span class="pi">:</span> <span class="s">true</span>
<span class="s">only_date</span><span class="pi">:</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">Input with only date</span>
<span class="s">has_date</span><span class="pi">:</span> <span class="s">true</span>
<span class="s">has_time</span><span class="pi">:</span> <span class="s">false</span>
<span class="s">only_time</span><span class="pi">:</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">Input with only time</span>
<span class="s">has_date</span><span class="pi">:</span> <span class="s">false</span>
<span class="s">has_time</span><span class="pi">:</span> <span class="s">true</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>[alias]</strong> (<em>Required</em>): Alias for the datetime input. Multiple entries are allowed.
<ul>
<li><strong>name</strong> (<em>Optional</em>): Friendly name of the datetime input.</li>
<li><strong>has_time</strong> (<em>Optional</em>): Set to <code class="highlighter-rouge">true</code> if this input should have time. Defaults to <code class="highlighter-rouge">false</code>.</li>
<li><strong>has_date</strong> (<em>Optional</em>): Set to <code class="highlighter-rouge">true</code> if this input should have a date. Defaults to <code class="highlighter-rouge">false</code>.</li>
<li><strong>initial</strong> (<em>Optional</em>): Set the initial value of this input. Defaults to ‘1970-01-01 00:00’.</li>
</ul>
</li>
</ul>
<p>A datetime input entity’s state exports several attributes that can be useful in automations and templates:</p>
<ul>
<li><strong>has_time</strong>: <code class="highlighter-rouge">true</code> if this entity has time.</li>
<li><strong>has_date</strong>: <code class="highlighter-rouge">true</code> if this entity has a date.</li>
<li><strong>year</strong>, <strong>month</strong>, <strong>day</strong> (Only available if <em>has_date</em> is true): The year, month and day of the date.</li>
<li><strong>hour</strong>, <strong>minute</strong>, <strong>second</strong> (Only available if <em>has_time</em> is true): The hour, minute and second of the time.</li>
<li><strong>timestamp</strong>: A timestamp representing the time held in the input. If <em>has_date</em> is true, this is the UNIX timestamp of the date / time held by the input. Otherwise (i.e., if only <em>has_time</em> is true) the number of seconds since midnight representing the time held by the input.</li>
</ul>
</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_datetime.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.55
</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>
Input Datetime
</li>
<li>
<a href='/components/input_number/'>Input Number</a>
</li>
<li>
<a href='/components/input_select/'>Input Select</a>
</li>
<li>
<a href='/components/input_text/'>Input Text</a>
</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>
Reference in a new issue View git blame Copy permalink