jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Site updated at 2017-03-18 17:12:07 UTC

Browse source
This commit is contained in:
Travis CI 2017-03-18 17:12:07 +00:00
parent 7573fcba68
commit 67179bf8fe
994 changed files with 1768 additions and 68252 deletions
Download patch file Download diff file Expand all files Collapse all files

56
components/notify.discord/index.html
View file

@ -3,17 +3,14 @@
<!--[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>Discord - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to add Discord notifications to Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/notify.discord/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Discord">
<meta property="og:site_name" content="Home Assistant">
@ -21,39 +18,31 @@
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to add Discord notifications to 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="Discord">
<meta name="twitter:description" content="Instructions how to add Discord notifications to Home Assistant.">
<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>
@ -64,42 +53,24 @@
</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">
Discord
</h1>
</header>
<hr class="divider">
<p>The <a href="https://discordapp.com/">Discord service</a> is a platform for the notify component. This allows components to send messages to the user using Discord.</p>
<p>In order to get a token you need to go to the <a href="https://discordapp.com/developers/applications/me">Discord My Apps page</a> and create a new application. Once the application is ready, create a bot user. Retreive the client ID and the (hidden) token of your bot for later.</p>
<p>When setting up the application you can use this <a href="https://home-assistant.io/demo/favicon-192x192.png">icon</a>.</p>
<h3><a class="title-link" name="configuration" href="#configuration"></a> Configuration</h3>
<p>To use Discord notifications, add the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">notify</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">name</span><span class="pi">:</span> <span class="s">NOTIFIER_NAME</span>
@ -107,31 +78,22 @@
<span class="s">token</span><span class="pi">:</span> <span class="s">A1aB2b.C3cD4d-E5eF6f</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>name</strong> (<em>Optional</em>): Setting the optional parameter <code class="highlighter-rouge">name</code> allows multiple notifiers to be created. The default value is <code class="highlighter-rouge">notify</code>. The notifier will bind to the service <code class="highlighter-rouge">notify.NOTIFIER_NAME</code>.</li>
<li><strong>token</strong> (<em>Required</em>): Your bot’s token.</li>
</ul>
<h3><a class="title-link" name="using-the-bot" href="#using-the-bot"></a> Using the bot</h3>
<p>Bots can only send messages to servers. To add the bot to a server you are an admin on, use the Discord OAuth2 Authorization page:</p>
<p><a href="https://discordapp.com/api/oauth2/authorize?client_id=1234567890&amp;scope=bot&amp;permissions=0">https://discordapp.com/api/oauth2/authorize?client_id=1234567890&amp;scope=bot&amp;permissions=0</a></p>
<p>Replace the client ID with the appropriate one from the <a href="https://discordapp.com/developers/applications/me">Discord My Apps page</a>.</p>
<p>Once the bot user has been added to your server, get the channel ID of the channel you want the bot to operate in.</p>
<ul>
<li>In The Discord app go to Settings &gt; Appearance &gt; Check developer mode</li>
<li>Right click channel name &gt; Copy ID</li>
</ul>
<p>This channel ID has to be used as the target when calling the notification service. Multiple channel IDs can be specified, across multiple servers.</p>
<h4><a class="title-link" name="example-service-payload" href="#example-service-payload"></a> Example service payload</h4>
<div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
</span><span class="nt">"message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"A message from Home Assistant"</span><span class="p">,</span><span class="w">
</span><span class="nt">"target"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
@ -141,24 +103,13 @@
</span><span class="p">}</span><span class="w">
</span></code></pre>
</div>
<h3><a class="title-link" name="notes" href="#notes"></a> Notes</h3>
<p>For more information about creating and authorizing bots, visit the <a href="https://discordapp.com/developers/docs/topics/oauth2">OAuth2 information page</a></p>
<p>To use notifications effectively, please see the <a href="/getting-started/automation/">getting started with automation page</a>.</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/notify.discord.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
@ -306,13 +257,10 @@
</ul>
</div>
</section>
</div>
</aside>
</div>
</div>
<footer>
<div class="grid-wrapper">
<div class="grid">
@ -322,7 +270,6 @@
<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 />
@ -334,7 +281,6 @@
</div>
</div>
</footer>
<script>
var _gaq=[['_setAccount','UA-57927901-1'],['_trackPageview']];
(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
@ -342,4 +288,4 @@
s.parentNode.insertBefore(g,s)}(document,'script'));
</script>
</body>
</html>
</html>