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

Site updated at 2015-10-29 07:09:11 UTC

Browse source
This commit is contained in:
Paulus Schoutsen 2015-10-29 00:09:11 -07:00
parent 7412a60701
commit b260f2881e
362 changed files with 42053 additions and 256343 deletions
Download patch file Download diff file Expand all files Collapse all files

233
components/notify.instapush/index.html Normal file
View file

@ -0,0 +1,233 @@
<!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>Instapush - Home Assistant</title>
<meta name="author" content="Paulus Schoutsen">
<meta name="description" content="Instructions how to add Instapush notifications to Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/notify.instapush/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Instapush">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/notify.instapush/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to add Instapush notifications to Home Assistant.">
<meta property="og:image" content="https://home-assistant.io/images/home-assistant-logo-2164x2164.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='/images/favicon-192x192.png'> Home Assistant
</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>
<ul>
<li><a href='/getting-started/'>Installing Home Assistant</a></li>
<li><a href='/getting-started/configuration/'>Configuration basics</a></li>
<li><a href='/getting-started/devices/'>Adding devices</a></li>
<li><a href='/getting-started/presence-detection/'>Presence detection</a></li>
<li><a href='/getting-started/automation/'>Automation</a></li>
<li><a href='/cookbook'>Configuration cookbook</a></li>
</ul>
</li>
<li><a href='/components/'>Components</a></li>
<li>
<a href="/developers/">Developers</a>
<ul>
<li><a href="/developers/architecture/">Architecture</a></li>
<li><a href="/developers/frontend/">Frontend development</a></li>
<li><a href="/developers/creating_components/">
Creating components
</a></li>
<li><a href="/developers/add_new_platform/">
Adding platform support
</a></li>
<li><a href="/developers/api/">API</a></li>
<li><a href="/developers/credits/">Credits</a></li>
</ul>
</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">
Instapush
</h1>
</header>
<hr class="divider">
<p>The instapush platform uses <a href="https://instapush.im">Instapush</a> to delivery notifications from Home Assistant to your Android or iOS device.</p>
<p>The Instapush <a href="https://instapush.im/home/start/">Getting Started page</a> will guide through the process of creating the required items.</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">instapush</span></span>
<span class="key">api_key</span>: <span class="string"><span class="content">ABCDEFGHJKLMNOPQRSTUVXYZ</span></span>
<span class="key">app_secret</span>: <span class="string"><span class="content">ABCDEFGHJKLMNOPQRSTUVXYZ</span></span>
<span class="key">event</span>: <span class="string"><span class="content">ABCDEFGHJKLMNOPQRSTUVXYZ</span></span>
<span class="key">tracker</span>: <span class="string"><span class="content">ABCDEFGHJKLMNOPQRSTUVXYZ</span></span>
</pre></div>
</div>
</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>api_key</strong> (<em>Required</em>): Your API key for Instapush.</li>
<li><strong>app_secret</strong> (<em>Required</em>): The secret for your created application.</li>
<li><strong>event</strong> (<em>Required</em>): TThe event</li>
<li><strong>tracker</strong> (<em>Required</em>): The name of tracker inside Instapush.</li>
</ul>
<p>To retrieve those values for existing settings, log into your account at https://instapush.im and go to your <strong>Dashboard</strong>. Then click <strong>APPS</strong> tab, choose an app, and check the <strong>Basic Info</strong> section. The <em>Application ID</em> is the <code>api_key</code> and <code>app_secret</code> is the <em>Application Secret</em>.</p>
<p>It’s easy to test your Instapush setup outside of Home Assistant. Assuming you have an event <em>notification</em> and a tracker <em>home-assistant</em>, just fire a request and check the Instapush dashboard for a new entry.</p>
<div class="highlighter-coderay"><div class="CodeRay">
<div class="code"><pre>curl -X POST \
-H &quot;x-instapush-appid: YOUR_APP_KEY&quot; \
-H &quot;x-instapush-appsecret: YOUR_APP_SECRET&quot; \
-H &quot;Content-Type: application/json&quot; \
-d '{&quot;event&quot;:&quot;notification&quot;,&quot;trackers&quot;:{&quot;home-assistant&quot;:&quot;Switch 1&quot;}}' \
https://api.instapush.im/v1/post
</pre></div>
</div>
</div>
<p>For further details, please check the <a href="https://instapush.im/developer/rest">API</a>.</p>
<p>To use notifications, please see the <a href="/components/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='brand-logo-container section'>
<img src='/images/supported_brands/instapush.png' />
</div>
<div class='section'>
This is a platform for
<a href='/components/notify/'>the Notifications component</a>.
</div>
<div class='section'>
<h1 class="title delta">Category Notifications</h1>
<ul class='divided'>
<li>
<a href='/components/notify.file/'>File</a>
</li>
<li>
Instapush
</li>
<li>
<a href='/components/notify.xmpp/'>Jabber (XMPP)</a>
</li>
<li>
<a href='/components/notify.nma/'>Notify My Android</a>
</li>
<li>
<a href='/components/notify.pushbullet/'>PushBullet</a>
</li>
<li>
<a href='/components/notify.pushover/'>PushOver</a>
</li>
<li>
<a href='/components/notify.smtp/'>SMTP</a>
</li>
<li>
<a href='/components/notify.slack/'>Slack</a>
</li>
<li>
<a href='/components/notify.syslog/'>Syslog</a>
</li>
<li>
<a href='/components/notify.telegram/'>Telegram</a>
</li>
</ul>
</div>
</section>
</div>
</aside>
</div>
</div>
<footer>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item">
<p class="copyright">
<span class="credit">Powered by <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>. Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.</span>
</p>
</div>
</div>
</div>
</footer>
<!--[if lt IE 7]>
<p class="chromeframe">You are using an <strong>outdated</strong> browser. Please <a href="http://browsehappy.com/">upgrade your browser</a> or <a href="http://www.google.com/chromeframe/?redirect=true">activate Google Chrome Frame</a> to improve your experience.</p>
<![endif]-->
<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>