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

Site updated at 2016-08-22 08:21:42 UTC

Browse source
This commit is contained in:
Travis CI 2016-08-22 08:21:43 +00:00
parent f9d65cbe57
commit 4acb07bf8e
559 changed files with 18878 additions and 21688 deletions
Download patch file Download diff file Expand all files Collapse all files

126
components/notify.telegram/index.html
View file

@ -89,64 +89,58 @@
<hr class="divider">
<p>The <code>telegram</code> platform uses <a href="https://web.telegram.org">Telegram</a> to delivery notifications from Home Assistant to your Android device, your Windows phone, or your iOS device.</p>
<p>The <code class="highlighter-rouge">telegram</code> platform uses <a href="https://web.telegram.org">Telegram</a> to delivery notifications from Home Assistant to your Android device, your Windows phone, or your iOS device.</p>
<p>The requirements are:</p>
<ul>
<li>You need a <a href="https://core.telegram.org/bots">Telegram bot</a>. Please follow those <a href="https://core.telegram.org/bots#botfather">instructions</a> to create one and get the token for your bot. Keep in mind that bots are not allowed to contact users. You need to make the first contact with your user. Meaning that you need to send a message to the bot from your user.</li>
<li>The <code>chat_id</code> of an user.</li>
<li>The <code class="highlighter-rouge">chat_id</code> of an user.</li>
</ul>
<p>The quickest way to retrieve your <code>chat_id</code> is visiting <a href="https://api.telegram.org/botYOUR_API_TOKEN/getUpdates">https://api.telegram.org/botYOUR_API_TOKEN/getUpdates</a>.</p>
<p>The quickest way to retrieve your <code class="highlighter-rouge">chat_id</code> is visiting <a href="https://api.telegram.org/botYOUR_API_TOKEN/getUpdates">https://api.telegram.org/botYOUR_API_TOKEN/getUpdates</a>.</p>
<p>The result set will include your chat ID as <code>id</code> in the <code>from</code> section:</p>
<p>The result set will include your chat ID as <code class="highlighter-rouge">id</code> in the <code class="highlighter-rouge">from</code> section:</p>
<div class="highlighter-coderay"><div class="CodeRay">
<div class="code"><pre>{
<span class="key"><span class="delimiter">&quot;</span><span class="content">ok</span><span class="delimiter">&quot;</span></span>:<span class="value">true</span>,
<span class="key"><span class="delimiter">&quot;</span><span class="content">result</span><span class="delimiter">&quot;</span></span>:[
{
<span class="key"><span class="delimiter">&quot;</span><span class="content">update_id</span><span class="delimiter">&quot;</span></span>:<span class="integer">254199982</span>,
<span class="key"><span class="delimiter">&quot;</span><span class="content">message</span><span class="delimiter">&quot;</span></span>:{
<span class="key"><span class="delimiter">&quot;</span><span class="content">message_id</span><span class="delimiter">&quot;</span></span>:<span class="integer">201</span>,
<span class="key"><span class="delimiter">&quot;</span><span class="content">from</span><span class="delimiter">&quot;</span></span>:{
<span class="key"><span class="delimiter">&quot;</span><span class="content">id</span><span class="delimiter">&quot;</span></span>:<span class="integer">123456789</span>,
<span class="key"><span class="delimiter">&quot;</span><span class="content">first_name</span><span class="delimiter">&quot;</span></span>:<span class="string"><span class="delimiter">&quot;</span><span class="content">Your first name</span><span class="delimiter">&quot;</span></span>,
<span class="error">.</span><span class="error">.</span><span class="error">.</span>
</pre></div>
</div>
<div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
</span><span class="nt">"ok"</span><span class="p">:</span><span class="kc">true</span><span class="p">,</span><span class="w">
</span><span class="nt">"result"</span><span class="p">:[</span><span class="w">
</span><span class="p">{</span><span class="w">
</span><span class="nt">"update_id"</span><span class="p">:</span><span class="mi">254199982</span><span class="p">,</span><span class="w">
</span><span class="nt">"message"</span><span class="p">:{</span><span class="w">
</span><span class="nt">"message_id"</span><span class="p">:</span><span class="mi">201</span><span class="p">,</span><span class="w">
</span><span class="nt">"from"</span><span class="p">:{</span><span class="w">
</span><span class="nt">"id"</span><span class="p">:</span><span class="mi">123456789</span><span class="p">,</span><span class="w">
</span><span class="nt">"first_name"</span><span class="p">:</span><span class="s2">"Your first name"</span><span class="p">,</span><span class="w">
</span><span class="err">...</span><span class="w">
</span></code></pre>
</div>
<p>Another way to get your chat ID directly is described below:</p>
<div class="highlighter-coderay"><div class="CodeRay">
<div class="code"><pre><span class="keyword">import</span> <span class="include">telegram</span>
bot = telegram.Bot(token=<span class="string"><span class="delimiter">'</span><span class="content">YOUR_API_TOKEN</span><span class="delimiter">'</span></span>)
chat_id = bot.getUpdates()[-<span class="integer">1</span>].message.chat_id
print(chat_id)
<span class="integer">123456789</span>
</pre></div>
</div>
<div class="language-python highlighter-rouge"><pre class="highlight"><code><span class="kn">import</span> <span class="nn">telegram</span>
<span class="n">bot</span> <span class="o">=</span> <span class="n">telegram</span><span class="o">.</span><span class="n">Bot</span><span class="p">(</span><span class="n">token</span><span class="o">=</span><span class="s">'YOUR_API_TOKEN'</span><span class="p">)</span>
<span class="n">chat_id</span> <span class="o">=</span> <span class="n">bot</span><span class="o">.</span><span class="n">getUpdates</span><span class="p">()[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">message</span><span class="o">.</span><span class="n">chat_id</span>
<span class="k">print</span><span class="p">(</span><span class="n">chat_id</span><span class="p">)</span>
<span class="mi">123456789</span>
</code></pre>
</div>
<p>To enable Telegram notifications in your installation, add the following to your <code>configuration.yaml</code> file:</p>
<p>To enable Telegram notifications in your installation, add the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
<div class="highlighter-coderay"><div class="CodeRay">
<div class="code"><pre><span class="comment"># Example configuration.yaml entry</span>
<span class="key">notify</span>:
<span class="key">name</span>: <span class="string"><span class="content">NOTIFIER_NAME</span></span>
<span class="key">platform</span>: <span class="string"><span class="content">telegram</span></span>
<span class="key">api_key</span>: <span class="string"><span class="content">ABCDEFGHJKLMNOPQRSTUVXYZ</span></span>
<span class="key">chat_id</span>: <span class="string"><span class="content">YOUR_CHAT_ID</span></span>
</pre></div>
</div>
<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="s">name</span><span class="pi">:</span> <span class="s">NOTIFIER_NAME</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">telegram</span>
<span class="s">api_key</span><span class="pi">:</span> <span class="s">ABCDEFGHJKLMNOPQRSTUVXYZ</span>
<span class="s">chat_id</span><span class="pi">:</span> <span class="s">YOUR_CHAT_ID</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>name</strong> (<em>Optional</em>): Setting the optional parameter <code>name</code> allows multiple notifiers to be created. The default value is <code>notify</code>. The notifier will bind to the service <code>notify.NOTIFIER_NAME</code>.</li>
<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>api_key</strong> (<em>Required</em>): The API token of your bot.</li>
<li><strong>chat_id</strong> (<em>Required</em>: The chat ID of your user.</li>
</ul>
@ -155,24 +149,22 @@ print(chat_id)
<h3><a class="title-link" name="photo-support" href="#photo-support"></a> Photo support</h3>
<div class="highlighter-coderay"><div class="CodeRay">
<div class="code"><pre><span class="head"><span class="head">...</span></span>
<span class="key">action</span>:
<span class="key">service</span>: <span class="string"><span class="content">notify.NOTIFIER_NAME</span></span>
<span class="key">data</span>:
<span class="key">title</span>: <span class="string"><span class="content">Send an images</span></span>
<span class="key">message</span>: <span class="string"><span class="content">That's a example that sends an image.</span></span>
<span class="key">data</span>:
<span class="key">photo</span>:
- <span class="string"><span class="content">url: http://192.168.1.28/camera.jpg</span></span>
<span class="key">username</span>: <span class="string"><span class="content">admin</span></span>
<span class="key">password</span>: <span class="string"><span class="content">secrete</span></span>
- <span class="string"><span class="content">file: /tmp/picture.jpg</span></span>
<span class="key">caption</span>: <span class="string"><span class="content">Picture Title xy</span></span>
- <span class="string"><span class="content">url: http://somebla.ie/video.png</span></span>
<span class="key">caption</span>: <span class="string"><span class="content">I.e. for a Title</span></span>
</pre></div>
</div>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="nn">...</span>
<span class="s">action</span><span class="pi">:</span>
<span class="s">service</span><span class="pi">:</span> <span class="s">notify.NOTIFIER_NAME</span>
<span class="s">data</span><span class="pi">:</span>
<span class="s">title</span><span class="pi">:</span> <span class="s">Send an images</span>
<span class="s">message</span><span class="pi">:</span> <span class="s">That's a example that sends an image.</span>
<span class="s">data</span><span class="pi">:</span>
<span class="s">photo</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">url</span><span class="pi">:</span> <span class="s">http://192.168.1.28/camera.jpg</span>
<span class="s">username</span><span class="pi">:</span> <span class="s">admin</span>
<span class="s">password</span><span class="pi">:</span> <span class="s">secrete</span>
<span class="pi">-</span> <span class="s">file</span><span class="pi">:</span> <span class="s">/tmp/picture.jpg</span>
<span class="s">caption</span><span class="pi">:</span> <span class="s">Picture Title xy</span>
<span class="pi">-</span> <span class="s">url</span><span class="pi">:</span> <span class="s">http://somebla.ie/video.png</span>
<span class="s">caption</span><span class="pi">:</span> <span class="s">I.e. for a Title</span>
</code></pre>
</div>
<ul>
@ -184,20 +176,18 @@ print(chat_id)
<h3><a class="title-link" name="location-support" href="#location-support"></a> Location support</h3>
<div class="highlighter-coderay"><div class="CodeRay">
<div class="code"><pre><span class="head"><span class="head">...</span></span>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="nn">...</span>
<span class="key">action</span>:
<span class="key">service</span>: <span class="string"><span class="content">notify.NOTIFIER_NAME</span></span>
<span class="key">data</span>:
<span class="key">title</span>: <span class="string"><span class="content">Send location</span></span>
<span class="key">message</span>: <span class="string"><span class="content">Location updated.</span></span>
<span class="key">data</span>:
<span class="key">location</span>:
<span class="key">latitude</span>: <span class="string"><span class="content">32.87336</span></span>
<span class="key">longitude</span>: <span class="string"><span class="content">117.22743</span></span>
</pre></div>
</div>
<span class="s">action</span><span class="pi">:</span>
<span class="s">service</span><span class="pi">:</span> <span class="s">notify.NOTIFIER_NAME</span>
<span class="s">data</span><span class="pi">:</span>
<span class="s">title</span><span class="pi">:</span> <span class="s">Send location</span>
<span class="s">message</span><span class="pi">:</span> <span class="s">Location updated.</span>
<span class="s">data</span><span class="pi">:</span>
<span class="s">location</span><span class="pi">:</span>
<span class="s">latitude</span><span class="pi">:</span> <span class="s">32.87336</span>
<span class="s">longitude</span><span class="pi">:</span> <span class="s">117.22743</span>
</code></pre>
</div>
<ul>