jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions
home-assistant.github.io/getting-started/customizing-devices/index.html
Travis CI b5e71ddf82 Site updated at 2017-01-31 15:23:27 UTC
2017-01-31 15:23:27 +00:00

344 lines
No EOL
18 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>Customizing devices and services - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Simple customization for devices and services in the frontend.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/getting-started/customizing-devices/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Customizing devices and services">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/getting-started/customizing-devices/">
<meta property="og:type" content="website">
<meta property="og:description" content="Simple customization for devices and services in the frontend.">
<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="Customizing devices and services">
<meta name="twitter:description" content="Simple customization for devices and services in the frontend.">
<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">
Customizing Devices and Services
</h1>
</header>
<hr class="divider">
<p>By default, all of your devices will be visible and have a default icon determined by their domain. You can customize the look and feel of your front page by altering some of these parameters. This can be done by overriding attributes of specific entities.</p>
<p>This format works for version 0.37+. For pre-0.37 use <a href="https://home-assistant.io/getting-started/customizing-devices/#older-format">Older format</a></p>
<p><code class="highlighter-rouge">customize</code> consists of a list of attribute customization blocks</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">homeassistant</span><span class="pi">:</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">Home</span>
<span class="s">unit_system</span><span class="pi">:</span> <span class="s">metric</span>
<span class="c1"># etc</span>
<span class="s">customize</span><span class="pi">:</span>
<span class="c1"># Only the 'entity_id' is required. All other options are optional.</span>
<span class="pi">-</span> <span class="s">entity_id</span><span class="pi">:</span> <span class="s">sensor.living_room_motion</span>
<span class="s">hidden</span><span class="pi">:</span> <span class="s">true</span>
<span class="pi">-</span> <span class="s">entity_id</span><span class="pi">:</span> <span class="s">thermostat.family_roomfamily_room</span>
<span class="s">entity_picture</span><span class="pi">:</span> <span class="s">https://example.com/images/nest.jpg</span>
<span class="s">friendly_name</span><span class="pi">:</span> <span class="s">Nest</span>
<span class="pi">-</span> <span class="s">entity_id</span><span class="pi">:</span> <span class="s">switch.wemo_switch_1</span>
<span class="s">friendly_name</span><span class="pi">:</span> <span class="s">Toaster</span>
<span class="s">entity_picture</span><span class="pi">:</span> <span class="s">/local/toaster.jpg</span>
<span class="pi">-</span> <span class="s">entity_id</span><span class="pi">:</span> <span class="s">switch.wemo_switch_2</span>
<span class="s">friendly_name</span><span class="pi">:</span> <span class="s">Kitchen kettle</span>
<span class="s">icon</span><span class="pi">:</span> <span class="s">mdi:kettle</span>
<span class="pi">-</span> <span class="s">entity_id</span><span class="pi">:</span> <span class="s">switch.rfxtrx_switch</span>
<span class="s">assumed_state</span><span class="pi">:</span> <span class="s">false</span>
</code></pre>
</div>
<h3><a class="title-link" name="possible-values" href="#possible-values"></a> Possible values</h3>
<table>
<thead>
<tr>
<th>Attribute</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code class="highlighter-rouge">friendly_name</code></td>
<td>Name of the entity</td>
</tr>
<tr>
<td><code class="highlighter-rouge">hidden</code></td>
<td>Set to <code class="highlighter-rouge">true</code> to hide the entity.</td>
</tr>
<tr>
<td><code class="highlighter-rouge">entity_picture</code></td>
<td>Url to use as picture for entity</td>
</tr>
<tr>
<td><code class="highlighter-rouge">icon</code></td>
<td>Any icon from <a href="http://MaterialDesignIcons.com">MaterialDesignIcons.com</a>. Prefix name with <code class="highlighter-rouge">mdi:</code>, ie <code class="highlighter-rouge">mdi:home</code>.</td>
</tr>
<tr>
<td><code class="highlighter-rouge">assumed_state</code></td>
<td>For switches with an assumed state two buttons are shown (turn off, turn on) instead of a switch. By setting <code class="highlighter-rouge">assumed_state</code> to <code class="highlighter-rouge">false</code> you will get the default switch icon.</td>
</tr>
<tr>
<td><code class="highlighter-rouge">sensor_class</code></td>
<td>Sets the <a href="/components/binary_sensor/">class of the sensor</a>, changing the device state and icon that is displayed on the UI (see below).</td>
</tr>
</tbody>
</table>
<h3><a class="title-link" name="advanced-example" href="#advanced-example"></a> Advanced example</h3>
<p>You can also specify attributes for all devices in a domain, use wildcards, use several entity IDs as a list or comma separated list.</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">homeassistant</span><span class="pi">:</span>
<span class="s">customize</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">entity_id</span><span class="pi">:</span> <span class="s">sensor</span>
<span class="s">icon</span><span class="pi">:</span> <span class="s">mdi:kettle</span> <span class="c1"># Give all sensor the kettle icon</span>
<span class="pi">-</span> <span class="s">entity_id</span><span class="pi">:</span> <span class="s">light.family*</span>
<span class="s">hidden</span><span class="pi">:</span> <span class="s">true</span> <span class="c1"># Hide all lights that have an ID starting with 'family'</span>
<span class="pi">-</span> <span class="s">entity_id</span><span class="pi">:</span> <span class="s">switch.wemo_switch_1,switch.wemo_switch_2,switch.wemo_switch_3</span>
<span class="s">entity_picture</span><span class="pi">:</span> <span class="s">/local/toaster.jpg</span> <span class="c1"># Set picture on multiple devices</span>
</code></pre>
</div>
<p>Either <code class="highlighter-rouge">entity_id</code> must be present in each customization block.</p>
<h3><a class="title-link" name="older-format" href="#older-format"></a> Older format</h3>
<p>In the previous version of customize format the keys were the IDs:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">homeassistant</span><span class="pi">:</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">Home</span>
<span class="s">unit_system</span><span class="pi">:</span> <span class="s">metric</span>
<span class="c1"># etc</span>
<span class="s">customize</span><span class="pi">:</span>
<span class="c1"># Only the 'entity_id' is required. All other options are optional.</span>
<span class="s">sensor.living_room_motion</span><span class="pi">:</span>
<span class="s">hidden</span><span class="pi">:</span> <span class="s">true</span>
<span class="s">thermostat.family_roomfamily_room</span><span class="pi">:</span>
<span class="s">entity_picture</span><span class="pi">:</span> <span class="s">https://example.com/images/nest.jpg</span>
<span class="s">friendly_name</span><span class="pi">:</span> <span class="s">Nest</span>
<span class="s">switch.wemo_switch_1</span><span class="pi">:</span>
<span class="s">friendly_name</span><span class="pi">:</span> <span class="s">Toaster</span>
<span class="s">entity_picture</span><span class="pi">:</span> <span class="s">/local/toaster.jpg</span>
<span class="s">switch.wemo_switch_2</span><span class="pi">:</span>
<span class="s">friendly_name</span><span class="pi">:</span> <span class="s">Kitchen kettle</span>
<span class="s">icon</span><span class="pi">:</span> <span class="s">mdi:kettle</span>
<span class="pi">-</span> <span class="s">entity_id</span><span class="pi">:</span> <span class="s">switch.rfxtrx_switch</span><span class="pi">:</span>
<span class="s">assumed_state</span><span class="pi">:</span> <span class="s">false</span>
</code></pre>
</div>
<p>This format doesn’t support comma-separated IDs, wildcards or domain matching.</p>
<p>The formats can’t be mixed</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code> <span class="c1"># NOT A VALID CONFIGURATION</span>
<span class="s">customize</span><span class="pi">:</span>
<span class="s">sensor.living_room_motion</span><span class="pi">:</span>
<span class="s">hidden</span><span class="pi">:</span> <span class="s">true</span>
<span class="pi">-</span> <span class="s">entity_id</span><span class="pi">:</span> <span class="s">thermostat.family_roomfamily_room</span>
<span class="s">friendly_name</span><span class="pi">:</span> <span class="s">Nest</span>
</code></pre>
</div>
<h3><a class="title-link" name="reloading-customize" href="#reloading-customize"></a> Reloading customize</h3>
<p>Home Assistant offers a service to reload the core configuration while Home Assistant is running called <code class="highlighter-rouge">homeassistant/reload_core_config</code>. This allows you to change your customize section and see it being applied without having to restart Home Assistant. To call this service, go to the <img src="/images/screenshots/developer-tool-services-icon.png" alt="service developer tool icon" class="no-shadow" height="38" /> service developer tools, select the service <code class="highlighter-rouge">homeassistant/reload_core_config</code> and click “Call Service”.</p>
<p class="note warning">
New customize information will be applied the next time the state of the entity gets updated.
</p>
<h3><a href="/getting-started/presence-detection/">Next step: Setting up presence detection »</a></h3>
</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/getting-started/customizing-devices.markdown'>Edit this page on GitHub</a></div>
<div class='section'>
<h1 class="title delta">Getting Started Guide</h1>
<ul class='divided sidebar-menu'>
<li>
<a href='/getting-started/'>Installation </a>
<ul>
<li><a href='/getting-started/installation-raspberry-pi/'>Raspberry Pi </a></li>
<li><a href='/getting-started/installation-raspberry-pi-all-in-one/'>Raspberry Pi All-In-One Installer </a></li>
<li><a href='/getting-started/installation-raspberry-pi-image/'>Raspberry Pi Image </a></li>
<li><a href='/getting-started/installation-docker/'>Docker </a></li>
<li><a href='/getting-started/installation-vagrant/'>Vagrant </a></li>
<li><a href='/getting-started/installation-synology/'>Synology NAS </a></li>
<li><a href='/getting-started/installation-virtualenv/'>Virtualenv Linux </a></li>
<li><a href='/getting-started/updating/'>Updating </a></li>
<li><a href='/getting-started/troubleshooting/'>Troubleshooting </a></li>
</ul>
</li>
<li>
<a href='/getting-started/configuration/'>Configuration </a>
<ul>
<li><a href='/getting-started/yaml/'>YAML </a></li>
<li><a href='/getting-started/basic/'>Basic information </a></li>
<li><a href='/getting-started/devices/'>Setting up devices </a></li>
<li><a class='active' href='/getting-started/customizing-devices/'>Customizing devices and services </a></li>
<li><a href='/getting-started/presence-detection/'>Presence Detection </a></li>
<li><a href='/getting-started/troubleshooting-configuration/'>Troubleshooting </a></li>
<li><a href='/getting-started/securing/'>Security Check Points </a></li>
</ul>
</li>
<li>
<a href='/getting-started/automation/'>Automation </a>
<ul>
<li><a href='/getting-started/automation-create-first/'>Tutorial </a></li>
<li><a href='/getting-started/automation-trigger/'>Triggers </a></li>
<li><a href='/getting-started/automation-condition/'>Conditions </a></li>
<li><a href='/getting-started/automation-action/'>Actions </a></li>
<li><a href='/getting-started/automation-templating/'>Templates </a></li>
</ul>
</li>
<li>
<a href='/getting-started/scripts/'>Scripts </a>
<ul>
<li><a href='/getting-started/scripts-service-calls/'>Service Calls </a></li>
<li><a href='/getting-started/scripts-conditions/'>Conditions </a></li>
</ul>
</li>
<li>
<a href='/getting-started/z-wave/'>Z-Wave </a>
<ul>
<li><a href='/getting-started/z-wave-controllers/'>Controllers </a></li>
<li><a href='/getting-started/z-wave-settings/'>Modifying Settings </a></li>
<li><a href='/getting-started/z-wave-device-specific/'>Device Specific </a></li>
</ul>
</li>
<li>
<a href='/getting-started/autostart/'>Autostart </a>
<ul>
<li><a href='/getting-started/autostart-systemd/'>Linux - systemd </a></li>
<li><a href='/getting-started/autostart-upstart/'>Linux - Upstart </a></li>
<li><a href='/getting-started/autostart-init.d/'>Linux - init.d </a></li>
<li><a href='/getting-started/autostart-macos/'>macOS </a></li>
<li><a href='/getting-started/autostart-synology/'>Synology NAS </a></li>
</ul>
</li>
<li><a href='/topics/'>Advanced Topics </a></li>
<li><a href='/details/'>Details </a></li>
<li><a href='/getting-started/mobile/'>Add to Android/iOS Homescreen </a></li>
<li><a href='/getting-started/browsers/'>Browser Compatibility List </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>.<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>
Reference in a new issue View git blame Copy permalink