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

Site updated at 2017-04-16 23:42:35 UTC

Browse source
This commit is contained in:
Travis CI 2017-04-16 23:42:35 +00:00
parent 2883a0accb
commit 863b80016a
36 changed files with 102 additions and 57 deletions
Download patch file Download diff file Expand all files Collapse all files

5
docs/ecosystem/ios/index.html
View file

@ -79,7 +79,7 @@
<h2>Basic requirements</h2>
<ul>
<li>iOS device running at least iOS 9, but iOS 10 is greatly preferred.</li>
<li>Home Assistant 0.31.1 or higher for push notification support.</li>
<li>Home Assistant 0.42.4 or higher for push notification support.</li>
<li>SSL is strongly recommended. Self-signed SSL certificates will not work due to Apple’s limitations.</li>
</ul>
<p>The <code class="highlighter-rouge">ios</code> component is the companion component for the Home Assistant iOS app. While not required, adding the <code class="highlighter-rouge">ios</code> component to your setup will greatly enhance the iOS app with new notification, location and sensor functions not possible with a standalone app.</p>
@ -91,7 +91,8 @@
<li>The <a href="/components/discovery"><code class="highlighter-rouge">discovery</code></a> component is enabled.</li>
<li>You have just installed the app and are at the getting started screen.</li>
</ol>
<p>Automated discovery and component loaded can only happen at first install of the app. You may need to wait a few minutes for the iOS component to load as the <code class="highlighter-rouge">discovery</code> component only scans the network every 5 minutes.</p>
<p>Automated discovery and component loading only happens at first install of the app. You may need to wait a few minutes for the iOS component to load as the <code class="highlighter-rouge">discovery</code> component only scans the network every 5 minutes.</p>
<p>After the first automated setup you need to add <code class="highlighter-rouge">ios:</code> to your configuration so that the component loads by default even after restarting Home Assistant.</p>
<h3>Manual Setup</h3>
<p>You may also manually load the <code class="highlighter-rouge">ios</code> component by adding the following to your configuration:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>

4
docs/ecosystem/ios/notifications/basic/index.html
View file

@ -89,7 +89,7 @@
<span class="s">trigger</span><span class="pi">:</span>
<span class="s">...</span>
<span class="s">action</span><span class="pi">:</span>
<span class="s">service</span><span class="pi">:</span> <span class="s">notify.iOSApp</span>
<span class="s">service</span><span class="pi">:</span> <span class="s">notify.ios_&lt;your_device_id_here&gt;</span>
<span class="s">data</span><span class="pi">:</span>
<span class="s">message</span><span class="pi">:</span> <span class="s2">"</span><span class="s">Something</span><span class="nv"> </span><span class="s">happened</span><span class="nv"> </span><span class="s">at</span><span class="nv"> </span><span class="s">home!"</span>
<span class="s">data</span><span class="pi">:</span>
@ -104,7 +104,7 @@
<span class="s">trigger</span><span class="pi">:</span>
<span class="s">...</span>
<span class="s">action</span><span class="pi">:</span>
<span class="s">service</span><span class="pi">:</span> <span class="s">notify.iOSApp</span>
<span class="s">service</span><span class="pi">:</span> <span class="s">notify.ios_&lt;your_device_id_here&gt;</span>
<span class="s">data</span><span class="pi">:</span>
<span class="s">message</span><span class="pi">:</span> <span class="s2">"</span><span class="s">Something</span><span class="nv"> </span><span class="s">happened</span><span class="nv"> </span><span class="s">at</span><span class="nv"> </span><span class="s">home!"</span>
<span class="s">data</span><span class="pi">:</span>

4
docs/ecosystem/ios/notifications/content_extensions/index.html
View file

@ -71,7 +71,7 @@
<h1>Map</h1>
<p>Will show a map with a red tipped pin at the coordinates given.
The map will be centered at the coordinates given.</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">service</span><span class="pi">:</span> <span class="s">notify.iOSApp</span>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">service</span><span class="pi">:</span> <span class="s">notify.ios_&lt;your_device_id_here&gt;</span>
<span class="s">data</span><span class="pi">:</span>
<span class="s">message</span><span class="pi">:</span> <span class="s">Something happened at home!</span>
<span class="s">data</span><span class="pi">:</span>
@ -91,7 +91,7 @@ The map will be centered at the coordinates given.</p>
The notification content is a real time MJPEG stream of a camera (assuming the camera supports it).</p>
<p>You can use the attachment parameters <code class="highlighter-rouge">content-type</code> and <code class="highlighter-rouge">hide-thumbnail</code> with camera.</p>
<p>You can view an example <a href="https://www.youtube.com/watch?v=LmYwpxPKW0g">here</a>.</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">service</span><span class="pi">:</span> <span class="s">notify.iOSApp</span>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">service</span><span class="pi">:</span> <span class="s">notify.ios_&lt;your_device_id_here&gt;</span>
<span class="s">data</span><span class="pi">:</span>
<span class="s">message</span><span class="pi">:</span> <span class="s">Motion detected in the Living Room</span>
<span class="s">data</span><span class="pi">:</span>

9
docs/ecosystem/ios/notifications/index.html
View file

@ -68,7 +68,14 @@
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">ios</code> notify platform enables sending push notifications to the Home Assistant iOS app.</p>
<p>The ‘ios’ component will automatically load the notify service. No extra configuration is needed or supported.</p>
<p>The ‘ios’ component will automatically load the notify service.
The service component can be called using <code class="highlighter-rouge">service: notify.ios_&lt;your_device_ID&gt;</code>.
Your device ID can be found in the <code class="highlighter-rouge">ios.conf</code> file in your configuration folder. The file is compressed JSON. You can view it easier by copying the file contents and pasting them into <a href="http://jsonlint.com">JSONLint</a>.</p>
<p>In this example, the device ID is <code class="highlighter-rouge">robbiet480_7plus</code>, so the notify service to use is <code class="highlighter-rouge">notify.ios_robbiet480_7plus</code>:</p>
<div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="nt">"devices"</span><span class="p">:{</span><span class="nt">"robbiet480_7plus"</span><span class="p">:{</span><span class="nt">"app"</span><span class="p">:{</span><span class="nt">"bundleIdentifer"</span><span class="p">:</span><span class="s2">"io.robbie.HomeAssistant"</span><span class="p">,</span><span class="nt">"versionNumber"</span><span class="p">:</span><span class="mi">1</span><span class="p">,</span><span class="nt">"buildNumber"</span><span class="p">:</span><span class="mi">53</span><span class="p">},</span><span class="nt">"pushSounds"</span><span class="p">:[],</span><span class="nt">"permissions"</span><span class="p">:[</span><span class="s2">"location"</span><span class="p">],</span><span class="nt">"deviceId"</span><span class="p">:</span><span class="s2">"robbiet480_7plus"</span><span class="p">,</span><span class="nt">"device"</span><span class="p">:{</span><span class="nt">"type"</span><span class="p">:</span><span class="s2">"iPhone 7 Plus"</span><span class="p">,</span><span class="nt">"systemName"</span><span class="p">:</span><span class="s2">"iOS"</span><span class="p">,</span><span class="nt">"systemVersion"</span><span class="p">:</span><span class="s2">"10.3"</span><span class="p">,</span><span class="nt">"permanentID"</span><span class="p">:</span><span class="s2">"AB9F02FE-6AC6-47B8-ADEB-5DD87B489156"</span><span class="p">,</span><span class="nt">"localizedModel"</span><span class="p">:</span><span class="s2">"iPhone"</span><span class="p">,</span><span class="nt">"name"</span><span class="p">:</span><span class="s2">"Robbie's iPhone 7 Plus"</span><span class="p">,</span><span class="nt">"model"</span><span class="p">:</span><span class="s2">"iPhone"</span><span class="p">},</span><span class="nt">"battery"</span><span class="p">:{</span><span class="nt">"state"</span><span class="p">:</span><span class="s2">"Full"</span><span class="p">,</span><span class="nt">"level"</span><span class="p">:</span><span class="mi">100</span><span class="p">},</span><span class="nt">"pushToken"</span><span class="p">:</span><span class="s2">"SECRET"</span><span class="p">,</span><span class="nt">"pushId"</span><span class="p">:</span><span class="s2">"SECRET"</span><span class="p">}}}</span><span class="w">
</span></code></pre>
</div>
<p>You can find more information in the <a href="https://home-assistant.io/docs/ecosystem/ios/notifications/basic/">Basic Notifications</a> documentation.</p>
</article>
</div>
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">

2
docs/ecosystem/ios/notifications/requesting_location_updates/index.html
View file

@ -76,7 +76,7 @@
<span class="s">trigger</span><span class="pi">:</span>
<span class="s">...</span>
<span class="s">action</span><span class="pi">:</span>
<span class="s">service</span><span class="pi">:</span> <span class="s">notify.iOSApp</span>
<span class="s">service</span><span class="pi">:</span> <span class="s">notify.ios_&lt;your_device_id_here&gt;</span>
<span class="s">data</span><span class="pi">:</span>
<span class="s">message</span><span class="pi">:</span> <span class="s2">"</span><span class="s">request_location_update"</span>
</code></pre>

2
docs/ecosystem/ios/notifications/sounds/index.html
View file

@ -73,7 +73,7 @@
<span class="s">trigger</span><span class="pi">:</span>
<span class="s">...</span>
<span class="s">action</span><span class="pi">:</span>
<span class="s">service</span><span class="pi">:</span> <span class="s">notify.iOSApp</span>
<span class="s">service</span><span class="pi">:</span> <span class="s">notify.ios_&lt;your_device_id_here&gt;</span>
<span class="s">data</span><span class="pi">:</span>
<span class="s">message</span><span class="pi">:</span> <span class="s">“Something happened at home!”</span>
<span class="s">data</span><span class="pi">:</span>