321 lines
16 KiB
HTML
321 lines
16 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>Cookbook - Home Assistant</title>
|
|
<meta name="author" content="Home Assistant">
|
|
<meta name="description" content="Community maintained list of different ways to use Home Assistant.">
|
|
<meta name="viewport" content="width=device-width">
|
|
<link rel="canonical" href="https://home-assistant.io/cookbook/">
|
|
<meta property="fb:app_id" content="338291289691179">
|
|
<meta property="og:title" content="Cookbook">
|
|
<meta property="og:site_name" content="Home Assistant">
|
|
<meta property="og:url" content="https://home-assistant.io/cookbook/">
|
|
<meta property="og:type" content="website">
|
|
<meta property="og:description" content="Community maintained list of different ways to use 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="Cookbook">
|
|
<meta name="twitter:description" content="Community maintained list of different ways to use 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">
|
|
Cookbook
|
|
</h1>
|
|
</header>
|
|
<hr class="divider">
|
|
<p>This is a community curated list of different ways to use Home Assistant. Most of these examples are using the <a href="/getting-started/automation/">automation</a> component and other built-in <a href="/components/#automation">automation related</a> and <a href="/components/#organization">organization</a> components available.</p>
|
|
<p>For <a href="/components/python_script/"><code class="highlighter-rouge">python_script:</code> examples</a> visit the <a href="https://community.home-assistant.io/c/projects/scripts">Scripts section</a> in our forum.</p>
|
|
<p>New recipes can be added via the <a href="https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_cookbook">home-assistant.io repository</a>.</p>
|
|
<p class="note">
|
|
A great place to find popular configurations is on this <a href="https://github.com/search?q=topic%3Ahome-assistant-config&type=Repositories">GitHub search</a> for repositories with the <code class="highlighter-rouge">home-assistant-config</code> topic.
|
|
</p>
|
|
<h3><a class="title-link" name="automation-examples" href="#automation-examples"></a> Automation Examples</h3>
|
|
<ul>
|
|
<li>
|
|
<p><a href="/cookbook/automation_for_rainy_days/">Automation for rainy days</a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="/cookbook/dim_and_brighten_lights/">Dim (and brighten) lights via a remote</a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="/cookbook/dim_lights_when_playing_media/">Dim lights when playing media</a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="/cookbook/automation_kodi_dynamic_input_select/">Dynamic input select with Kodi media</a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="/cookbook/automation_flashing_lights/">Examples for flashing lights</a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="/cookbook/automation_telegram_presence_alert/">Examples sending notification depending of the presence</a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="/cookbook/automation_first_light/">Examples using first light</a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="/cookbook/automation_sun/">Examples using the sun</a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="/cookbook/foscam_away_mode_PTZ/">Foscam Recording during Away Mode Only using Pan/Tilt/Zoom Control and Motion Detection</a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="/cookbook/perform_actions_based_on_input_select/">Perform actions based on input select</a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="/cookbook/restart_ha_if_wemo_switch_is_not_detected/">Restart Home Assistant if Wemo Switch is not detected</a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="/cookbook/send_a_reminder/">Send a reminder</a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="/cookbook/notify_if_over_threshold/">Send notification based on sensor</a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="/cookbook/notify_if__new_ha_release/">Send notification if new Home Assistant release</a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="/cookbook/sonos_say/">Sonos say script to speak with text-to-speech</a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="/cookbook/automation_enocean_phue/">Switch Philips Hue with enocean</a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="/cookbook/track_battery_level/">Track your battery level</a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="/cookbook/turn_on_light_for_10_minutes_when_motion_detected/">Turn on lights for 10 minutes after motion detected</a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="/cookbook/automation_using_timeinterval_inputboolean/">Using time interval and input boolean</a></p>
|
|
</li>
|
|
</ul>
|
|
<h3><a class="title-link" name="automation-in-python-examples" href="#automation-in-python-examples"></a> Automation in Python Examples</h3>
|
|
<ul>
|
|
<li>
|
|
<p><a href="/cookbook/python_component_automation/">Automation in Code</a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="/cookbook/python_component_simple_alarm/">Flash lights when intruder detected</a></p>
|
|
</li>
|
|
</ul>
|
|
<h3><a class="title-link" name="custom-python-component-examples" href="#custom-python-component-examples"></a> Custom Python Component Examples</h3>
|
|
<ul>
|
|
<li><a href="/cookbook/python_component_mqtt_basic/">Basic MQTT Example</a></li>
|
|
</ul>
|
|
<h3><a class="title-link" name="example-configurationyaml" href="#example-configurationyaml"></a> Example configuration.yaml</h3>
|
|
<ul>
|
|
<li>
|
|
<p><a href="https://github.com/arsaboo/homeassistant-config">Configuration.yaml by Alok Saboo <i class="icon-external-link"></i></a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="https://github.com/CCOSTAN/Home-AssistantConfig">Configuration.yaml by Carlo Costanzo <i class="icon-external-link"></i></a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="https://github.com/CiquattroFPV/Homeassistant-Example-Config">Configuration.yaml by Ciquattro <i class="icon-external-link"></i></a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="https://github.com/danichispa/hass">Configuration.yaml by Danichispa <i class="icon-external-link"></i></a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="https://github.com/Danielhiversen/home-assistant_config">Configuration.yaml by Daniel Høyer Iversen <i class="icon-external-link"></i></a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="https://github.com/GreenTurtwig/personal-home-automation/tree/master/Home%20Assistant">Configuration.yaml by GreenTurtwig <i class="icon-external-link"></i></a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="https://github.com/Instagraeme/Home-Assistant-Configuration">Configuration.yaml by InstaGraeme <i class="icon-external-link"></i></a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="https://github.com/Haynie-Research-and-Development/jarvis">Configuration.yaml by Lance Haynie <i class="icon-external-link"></i></a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="https://github.com/skalavala/smarthome">Configuration.yaml by Mahasri Kalavala <i class="icon-external-link"></i></a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="https://github.com/scottocs11/Home-Assistant-Config">Configuration.yaml by Scottoc11 <i class="icon-external-link"></i></a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="https://github.com/shortbloke/home_assistant_config">Configuration.yaml by Shortbloke <i class="icon-external-link"></i></a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="https://github.com/stanvx/Home-Assistant-Configuration">Configuration.yaml by Stanvx <i class="icon-external-link"></i></a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="https://github.com/Teagan42/HomeAssistantConfig">Configuration.yaml by Teagan42 <i class="icon-external-link"></i></a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="https://github.com/Vasiley/Home-Assistant-Main">Configuration.yaml by Vasiley <i class="icon-external-link"></i></a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="https://github.com/aneisch/home-assistant-config/">Configuration.yaml by aneisch <i class="icon-external-link"></i></a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="https://github.com/bah2830/Home-Assistant-Configs">Configuration.yaml by bah2830 <i class="icon-external-link"></i></a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="/cookbook/configuration_yaml_from_bassclarinetl2/">Configuration.yaml by bassclarinetl2</a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="https://github.com/cbulock/home-assistant-configs">Configuration.yaml by cbulock <i class="icon-external-link"></i></a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="https://github.com/chriskacerguis/Home-AssistantConfig">Configuration.yaml by chriskacerguis <i class="icon-external-link"></i></a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="https://github.com/cy1701/Home-Assistant-Configuration">Configuration.yaml by cy1701 <i class="icon-external-link"></i></a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="https://git.smith.bz/derf/homeautomation">Configuration.yaml by fredsmith <i class="icon-external-link"></i></a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="https://github.com/geekofweek/homeassistant">Configuration.yaml by geekofweek <i class="icon-external-link"></i></a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="https://github.com/gstevenson/ha-config">Configuration.yaml by gstevenson <i class="icon-external-link"></i></a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="https://github.com/happyleavesaoc/my-home-automation/tree/master/homeassistant">Configuration.yaml by happyleavesaoc <i class="icon-external-link"></i></a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="https://github.com/jjmontesl/home-assistant-config">Configuration.yaml by jjmontesl <i class="icon-external-link"></i></a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="https://github.com/mertenats/open-home-automation/tree/master/openhome">Configuration.yaml by mertenats <i class="icon-external-link"></i></a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="https://github.com/mf-social/Home-Assistant">Configuration.yaml by mf_social <i class="icon-external-link"></i></a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="https://github.com/ntalekt/homeassistant">Configuration.yaml by ntalekt <i class="icon-external-link"></i></a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="https://github.com/oakbrad/brad-homeassistant-config">Configuration.yaml by oakbrad <i class="icon-external-link"></i></a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="https://github.com/SilvrrGIT/HomeAssistant">Configuration.yaml by silvrr <i class="icon-external-link"></i></a></p>
|
|
</li>
|
|
</ul>
|
|
<h3><a class="title-link" name="infrastructure" href="#infrastructure"></a> Infrastructure</h3>
|
|
<ul>
|
|
<li>
|
|
<p><a href="/cookbook/owntracks_two_mqtt_broker/">OwnTracks with two MQTT brokers</a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="/cookbook/fail2ban/">fail2ban</a></p>
|
|
</li>
|
|
</ul>
|
|
<h3><a class="title-link" name="user-interface" href="#user-interface"></a> User Interface</h3>
|
|
<ul>
|
|
<li>
|
|
<p><a href="/cookbook/custom_panel_using_react/">Custom Panel using React</a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="https://github.com/andrey-git/home-assistant-custom-ui">Custom UI state-card by andrey-git <i class="icon-external-link"></i></a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="/cookbook/google_maps_card/">Show Google Maps as a card</a></p>
|
|
</li>
|
|
</ul>
|
|
</article>
|
|
</div>
|
|
</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>
|