160 lines
9.3 KiB
HTML
160 lines
9.3 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>Basic Service Example - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<meta name="description" content="">
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/cookbook/python_component_basic_service/">
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="Basic Service Example">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/cookbook/python_component_basic_service/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="">
|
||
<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="Basic Service Example">
|
||
<meta name="twitter:description" content="">
|
||
<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="/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>
|
||
</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">
|
||
Basic Service Example
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
<p>This is a simple “hello world” example to show the basics of registering a service. To use this example, create the file <code class="highlighter-rouge"><config dir>/custom_components/hello_service.py</code> and copy the below example code.</p>
|
||
<p>Services can be called from automation and from the service “Developer tools” in the frontend.</p>
|
||
<div class="language-python highlighter-rouge"><pre class="highlight"><code><span class="c"># The domain of your component. Should be equal to the name of your component.</span>
|
||
<span class="n">DOMAIN</span> <span class="o">=</span> <span class="s">'hello_service'</span>
|
||
|
||
<span class="n">ATTR_NAME</span> <span class="o">=</span> <span class="s">'name'</span>
|
||
<span class="n">DEFAULT_NAME</span> <span class="o">=</span> <span class="s">'World'</span>
|
||
|
||
|
||
<span class="k">def</span> <span class="nf">setup</span><span class="p">(</span><span class="n">hass</span><span class="p">,</span> <span class="n">config</span><span class="p">):</span>
|
||
<span class="s">"""Setup is called when Home Assistant is loading our component."""</span>
|
||
|
||
<span class="k">def</span> <span class="nf">handle_hello</span><span class="p">(</span><span class="n">call</span><span class="p">):</span>
|
||
<span class="n">name</span> <span class="o">=</span> <span class="n">call</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">ATTR_NAME</span><span class="p">,</span> <span class="n">DEFAULT_NAME</span><span class="p">)</span>
|
||
|
||
<span class="n">hass</span><span class="o">.</span><span class="n">states</span><span class="o">.</span><span class="nb">set</span><span class="p">(</span><span class="s">'hello_service.hello'</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span>
|
||
|
||
<span class="n">hass</span><span class="o">.</span><span class="n">services</span><span class="o">.</span><span class="n">register</span><span class="p">(</span><span class="n">DOMAIN</span><span class="p">,</span> <span class="s">'hello'</span><span class="p">,</span> <span class="n">handle_hello</span><span class="p">)</span>
|
||
|
||
<span class="c"># Return boolean to indicate that initialization was successfully.</span>
|
||
<span class="k">return</span> <span class="bp">True</span>
|
||
</code></pre>
|
||
</div>
|
||
<p>Load the component by adding the following to your <code class="highlighter-rouge">configuration.yaml</code>. When your component is loaded, a new service should be available to call.</p>
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># configuration.yaml entry</span>
|
||
<span class="s">hello_service</span><span class="pi">:</span>
|
||
</code></pre>
|
||
</div>
|
||
<p>Open the frontend and in the sidebar, click the first icon in the developer tool section. This will open the Call Service developer tool. On the right, find your service and click on it. This will automatically fill in the correct values.</p>
|
||
<p>Pressing “Call Service” will now call your service without any parameters. This will cause your service to create a state with the default name ‘World’. If you want to specify the name, you have to specify parameters. Add the following JSON as Service Data and press “Call Service again”.</p>
|
||
<div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
|
||
</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Planet"</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span></code></pre>
|
||
</div>
|
||
<p>The service will now overwrite the previous state with “Planet”.</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/_cookbook/python_component_basic_service.markdown'>Edit this page on GitHub</a></div>
|
||
<div class='section'>
|
||
<a href='/cookbook'>Back to the cookbook</a>
|
||
</div>
|
||
<div class='section'>
|
||
<h1 class="title delta">Custom Python Component Examples</h1>
|
||
<ul class='divided'>
|
||
<li>
|
||
<a href='/cookbook/python_component_mqtt_basic/'>Basic MQTT Example</a>
|
||
</li>
|
||
<li>
|
||
Basic Service Example
|
||
</li>
|
||
<li>
|
||
<a href='/cookbook/python_component_basic_state/'>Basic State Setting Example</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>
|