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

Site updated at 2017-04-30 19:44:56 UTC

Browse source
This commit is contained in:
Travis CI 2017-04-30 19:44:56 +00:00
parent 740f7d4f4b
commit eb8727c131
182 changed files with 1634 additions and 1387 deletions
Download patch file Download diff file Expand all files Collapse all files

7
docs/hassbian/customization/index.html
View file

@ -67,14 +67,17 @@
</h1>
</header>
<hr class="divider">
<p>To allow you to customize your installation further, we have included a set of Hassbian scripts.</p>
<p>To allow you to customize your installation further, we have included a tool called <code class="highlighter-rouge">hassbian-config</code>. This tool comes with a set of packages that can easily be installed for easier customization of your Home Assistant installation.</p>
<ul>
<li>Install Samba. Allows anyone on your network to edit your configuration from any computer. This share is unsecured and it’s usage is not recommended if you share your network with others.</li>
<li>Install Libcec. Adds local <a href="/components/hdmi_cec/">HDMI CEC support</a>.</li>
<li>Install Mosquitto MQTT server. Installs the latest Mosquitto package and client tools from the Mosquitto projects offical repository. Now includes websocket support.</li>
<li>Install Open Z-Wave. Installs Open Z-Wave and prepares for using a USB or GPIO ZWave controller.</li>
<li>Install Hue. hue: Configures the Python executable to allow usage of low numbered ports for use with Emulated Hue component thats used with Amazon Echo, Google Home and Mycroft.ai.</li>
<li>Install Tellstick. Installs the Tellstick package for controling and using a connected Tellstick.</li>
</ul>
<p>All of these scripts are available in the directory <code class="highlighter-rouge">/home/pi/hassbian-scripts/</code>. For more information about these scripts have a look at the <a href="https://github.com/home-assistant/hassbian-scripts#the-included-scripts">hassbian-scripts repository</a>.</p>
<p>The tool is available by running <code class="highlighter-rouge">hassbian-config</code>. To view the available packages run <code class="highlighter-rouge">hassbian-config show</code> and <code class="highlighter-rouge">sudo hassbian-config install PACKAGENAME</code>.
For more information about this tool have a look at the <a href="https://github.com/home-assistant/hassbian-scripts">hassbian-scripts repository</a>.</p>
</article>
</div>
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">

6
docs/hassbian/installation/index.html
View file

@ -69,9 +69,9 @@
<hr class="divider">
<p>The easiest way to install Home Assistant on your Raspberry Pi is by using HASSbian: a Raspberry Pi image with Home Assistant built-in. The image will install the latest version of Home Assistant on initial boot (~10 minutes).</p>
<ol>
<li><a href="https://github.com/home-assistant/pi-gen/releases/download/v1.1/image_2017-02-03-HASSbian.zip">Download the Hassbian 1.1 image</a> (359 MB)</li>
<li><a href="https://github.com/home-assistant/pi-gen/releases/latest">Download the Hassbian image</a> (364 MB)</li>
<li>Use <a href="https://etcher.io/">Etcher</a> to flash the image to your SD card</li>
<li>Ensure your Raspberry Pi has access to the internet.</li>
<li>Ensure your Raspberry Pi has wired access to the internet.</li>
<li>Insert SD card to Raspberry Pi and turn it on. Initial installation of Home Assistant will take about 5 minutes.</li>
</ol>
<p>These instructions are also available as a <a href="https://www.youtube.com/watch?v=iIz6XqDwHEk">video</a>. Additional information is available in this <a href="https://www.youtube.com/watch?v=tCGlQSsQ-Mc">video</a>.</p>
@ -80,6 +80,8 @@
<ul>
<li>GPIO pins are ready to use.</li>
<li>Bluetooth is ready to use (supported models only, no Bluetooth LE).</li>
<li>SSH server is enabled.</li>
<li>A tool called <code class="highlighter-rouge">hassbian_config</code>.</li>
</ul>
<h3><a class="title-link" name="technical-details" href="#technical-details"></a> Technical Details</h3>
<ul>

57
docs/hassbian/integrations/index.html
View file

@ -70,11 +70,19 @@
<p>Some components that are specific for the Raspberry Pi can require some further configuration outside of Home Assistant. All commands below are assumed to be executed with the <code class="highlighter-rouge">pi</code> account. For full documentation of these components refer to the <a href="/components">components</a> page.</p>
<h3><a class="title-link" name="bluetooth-tracker" href="#bluetooth-tracker"></a> Bluetooth Tracker</h3>
<p>The Bluetooth tracker will work on a Raspberry Pi 3 with the built-in Bluetooth module or with a USB Bluetooth device on any of the other Raspberry Pi’s.</p>
<p>Install the following external dependencies.</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>sudo apt-get install bluetooth libbluetooth-dev
</code></pre>
</div>
<p>After this follow the <a href="/components/device_tracker.bluetooth_tracker/">Bluetooth Tracker component</a> and <a href="/components/device_tracker/">Device Tracker page</a> pages.</p>
<p>Software needed for the tracker is pre-installed so just follow the <a href="/components/device_tracker.bluetooth_tracker/">Bluetooth Tracker component</a> and <a href="/components/device_tracker/">Device Tracker page</a> pages.</p>
<h3><a class="title-link" name="raspberry-pi-gpio" href="#raspberry-pi-gpio"></a> Raspberry Pi GPIO</h3>
<p>Each of the following devices are connected to the GPIO pins on the Raspberry Pi.
For more details about the GPIO layout, visit the <a href="https://www.raspberrypi.org/documentation/usage/gpio/">documentation</a> from the Raspberry Pi foundation.</p>
<p>Permission have been given to the <code class="highlighter-rouge">homeassistant</code> user to use the GPIO pins and all of the following components should require no underlying changes to work.
Just follow the component pages for each on how to add them to your Home Assistant installation.</p>
<ul>
<li><a href="/components/sensor.dht/">DHT Sensor</a>.</li>
<li><a href="/components/cover.rpi_gpio/">Raspberry Pi Cover</a>.</li>
<li><a href="/components/binary_sensor.rpi_gpio/">Raspberry PI GPIO Binary Sensor</a>.</li>
<li><a href="/components/switch.rpi_gpio/">Raspberry PI GPIO Switch</a>.</li>
<li><a href="/components/switch.rpi_rf/">Raspberry Pi RF Switch</a>.</li>
</ul>
<h3><a class="title-link" name="raspberry-pi-camera" href="#raspberry-pi-camera"></a> Raspberry Pi Camera</h3>
<p>The Raspberry Pi Camera is a specific camera for the Raspberry Pi boards. For more information about the camera I suggest reading the <a href="https://www.raspberrypi.org/documentation/usage/camera/">documentation</a> from the Raspberry Pi foundation.</p>
<p>To use the camera it needs to be enabled with the <code class="highlighter-rouge">raspi-config</code> utility.</p>
@ -82,46 +90,7 @@
</code></pre>
</div>
<p>Select <code class="highlighter-rouge">Enable camera</code> choose <code class="highlighter-rouge">&lt;Yes&gt;</code> and hit <code class="highlighter-rouge">Enter</code>, then go to <code class="highlighter-rouge">Finish</code> and you’ll be prompted to reboot.</p>
<p>After reboot add your <code class="highlighter-rouge">homeassistant</code> account to the <code class="highlighter-rouge">video</code> group.</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>sudo adduser homeassistant video
</code></pre>
</div>
<p>After this follow the <a href="/components/camera.rpi_camera/">Raspberry Pi Camera component</a> page.</p>
<h3><a class="title-link" name="raspberry-pi-gpio" href="#raspberry-pi-gpio"></a> Raspberry Pi GPIO</h3>
<p>Each of the following devices are connected to the GPIO pins on the Raspberry Pi.
For more details about the GPIO layout, visit the <a href="https://www.raspberrypi.org/documentation/usage/gpio/">documentation</a> from the Raspberry Pi foundation.</p>
<p>Since these are not normally used some extra permission will need to be added.
In general the permission that is needed is granted by adding the <code class="highlighter-rouge">homeassistant</code> account to the <code class="highlighter-rouge">gpio</code> group.</p>
<h3><a class="title-link" name="raspberry-pi-cover" href="#raspberry-pi-cover"></a> Raspberry Pi Cover</h3>
<p>Add your <code class="highlighter-rouge">homeassistant</code> account to the <code class="highlighter-rouge">gpio</code> group</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>sudo adduser homeassistant gpio
</code></pre>
</div>
<p>After this follow the <a href="/components/cover.rpi_gpio/">Raspberry Pi Cover component</a> page.</p>
<h3><a class="title-link" name="dht-sensor" href="#dht-sensor"></a> DHT Sensor</h3>
<p>Add your <code class="highlighter-rouge">homeassistant</code> account to the <code class="highlighter-rouge">gpio</code> group</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>sudo adduser homeassistant gpio
</code></pre>
</div>
<p>After this follow the <a href="/components/sensor.dht/">DHT Sensor component</a> page.</p>
<h3><a class="title-link" name="raspberry-pi-gpio-binary-sensor" href="#raspberry-pi-gpio-binary-sensor"></a> Raspberry PI GPIO Binary Sensor</h3>
<p>Add your <code class="highlighter-rouge">homeassistant</code> account to the <code class="highlighter-rouge">gpio</code> group</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>sudo adduser homeassistant gpio
</code></pre>
</div>
<p>After this follow the <a href="/components/binary_sensor.rpi_gpio/">Raspberry PI GPIO Binary Sensor component</a> page.</p>
<h3><a class="title-link" name="raspberry-pi-gpio-switch" href="#raspberry-pi-gpio-switch"></a> Raspberry PI GPIO Switch</h3>
<p>Add your <code class="highlighter-rouge">homeassistant</code> account to the <code class="highlighter-rouge">gpio</code> group.</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>sudo adduser homeassistant gpio
</code></pre>
</div>
<p>After this follow the <a href="/components/switch.rpi_gpio/">Raspberry PI GPIO Switch component</a> page.</p>
<h3><a class="title-link" name="raspberry-pi-rf-switch" href="#raspberry-pi-rf-switch"></a> Raspberry Pi RF Switch</h3>
<p>Add your <code class="highlighter-rouge">homeassistant</code> account to the <code class="highlighter-rouge">gpio</code> group</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>sudo adduser homeassistant gpio
</code></pre>
</div>
<p>After this follow the <a href="/components/switch.rpi_rf/">Raspberry Pi RF Switch component</a> page.</p>
<h3><a class="title-link" name="one-wire-sensor" href="#one-wire-sensor"></a> One wire Sensor</h3>
<p>The One wire sensor requires that support for it is enabled on the Raspberry Pi and that the One Wire device is connected to GPIO pin 4.
To enable One Wire support add the following line to the end of <code class="highlighter-rouge">/boot/config.txt</code></p>

6
docs/hassbian/upgrading/index.html
View file

@ -83,12 +83,6 @@ Log in as the <code class="highlighter-rouge">pi</code> account and execute the
<span class="gp">$ </span>sudo systemctl start home-assistant@homeassistant.service
</code></pre>
</div>
<h4><a class="title-link" name="upgrading-the-hassbian-scripts" href="#upgrading-the-hassbian-scripts"></a> Upgrading the hassbian-scripts</h4>
<p>To update the hassbian-scripts directory execute the following command as the <code class="highlighter-rouge">pi</code> user.</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span><span class="nb">cd</span> /home/pi/hassbian-scripts
<span class="gp">$ </span>git pull
</code></pre>
</div>
</article>
</div>
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">