490 lines
No EOL
16 KiB
HTML
490 lines
No EOL
16 KiB
HTML
<!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>Getting Started - Home Assistant</title>
|
||
<meta name="author" content="Paulus Schoutsen">
|
||
<meta name="description" content="Step by step guide to get started with Home Assistant.">
|
||
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/getting-started/">
|
||
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="Getting Started">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/getting-started/">
|
||
<meta property="og:type" content="website">
|
||
<meta property="og:description" content="Step by step guide to get started with Home Assistant.">
|
||
<meta property="og:image" content="https://home-assistant.io/images/home-assistant-logo-2164x2164.png">
|
||
|
||
<meta name="twitter:card" content="summary">
|
||
<meta name="twitter:site" content="@home_assistant">
|
||
|
||
<meta name="twitter:title" content="Getting Started">
|
||
<meta name="twitter:description" content="Step by step guide to get started with Home Assistant.">
|
||
<meta name="twitter: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='/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>Getting started <i class="icon icon-caret-down"></i></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='/topics/'>Advanced Topics</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a href='/components/'>Components</a></li>
|
||
<li><a href='/cookbook'>Examples</a></li>
|
||
<li>
|
||
<a>Developers <i class="icon icon-caret-down"></i></a>
|
||
<ul>
|
||
<li><a href="/developers/">Setup Development</a></li>
|
||
<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">
|
||
|
||
|
||
<div class='edit-github'><a href='https://github.com/balloob/home-assistant.io/tree/master/source/getting-started/index.markdown'>Edit this page on GitHub</a></div>
|
||
|
||
|
||
|
||
<header>
|
||
<h1 class="title indent">
|
||
Getting Started
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
|
||
|
||
<div class="install-instructions-container">
|
||
<input name="install-instructions" type="radio" id="normal-install" checked="" />
|
||
<input name="install-instructions" type="radio" id="raspberry-install" />
|
||
<input name="install-instructions" type="radio" id="docker-install" />
|
||
<input name="install-instructions" type="radio" id="synology-install" />
|
||
<label class="menu-selector normal" for="normal-install">Local machine</label>
|
||
<label class="menu-selector raspberry" for="raspberry-install">Raspberry Pi</label>
|
||
<label class="menu-selector docker" for="docker-install">Docker</label>
|
||
<label class="menu-selector synology" for="synology-install">Synology NAS</label>
|
||
|
||
<div class="install-instructions normal">
|
||
<p>Installing and running Home Assistant on your local machine is easy. Make sure you have <a href="https://www.python.org/downloads/">Python 3.4 or higher</a> installed and execute the following code in a console:</p>
|
||
|
||
<div class="highlighter-coderay"><div class="CodeRay">
|
||
<div class="code"><pre>$ pip3 install homeassistant
|
||
$ hass --open-ui
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
|
||
<p>Running these commands will:</p>
|
||
|
||
<ul>
|
||
<li>Install Home Assistant</li>
|
||
<li>Launch Home Assistant and serve the web interface on <a href="http://localhost:8123">http://localhost:8123</a></li>
|
||
</ul>
|
||
|
||
<p>If you prefer to watch a video tutorial, <a href="https://github.com/tktino">tktino</a> has made some great ones.</p>
|
||
|
||
<ul>
|
||
<li><a href="https://www.youtube.com/watch?v=X27eVvuqwnY">Windows 10</a></li>
|
||
<li><a href="https://www.youtube.com/watch?v=hej6ipN86ls">Mac OS X</a></li>
|
||
<li><a href="https://www.youtube.com/watch?v=SXaAG1lGNH0">Ubuntu 14.04</a></li>
|
||
</ul>
|
||
|
||
</div> <!-- INSTALL-INSTRUCTIONS NORMAL -->
|
||
|
||
|
||
<div class="install-instructions docker">
|
||
|
||
<p>Installation with Docker is straightforward. Adjust the following command so that <code>/path/to/your/config/</code> points at the folder where you want to store your config and run it:</p>
|
||
|
||
<div class="highlighter-coderay"><div class="CodeRay">
|
||
<div class="code"><pre>$ docker run -d --name="home-assistant" -v /path/to/your/config:/config -v /etc/localtime:/etc/localtime:ro --net=host balloob/home-assistant
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
|
||
<p>This will launch Home Assistant and serve the web interface from port 8123 on your Docker host.</p>
|
||
|
||
<p class="note">
|
||
When using boot2docker on OS X you are unable to map the local time to your Docker container. Replace <code>-v /etc/localtime:/etc/localtime:ro</code> with <code>-e "TZ=America/Los_Angeles"</code> (replacing America/Los_Angeles with <a href="http://en.wikipedia.org/wiki/List_of_tz_database_time_zones">your timezone</a>)
|
||
</p>
|
||
|
||
</div> <!-- INSTALL-INSTRUCTIONS DOCKER -->
|
||
|
||
|
||
<div class="install-instructions raspberry">
|
||
|
||
<p>Home Assistant requires the Raspberry Pi to run <a href="https://www.raspberrypi.org/downloads/raspbian/">Raspbian Jessie</a>. This version was released on September 24, 2015 and comes by default with Python 3.4 which is required for Home Assistant.</p>
|
||
|
||
<p>Execute the following code in a console:</p>
|
||
|
||
<div class="highlighter-coderay"><div class="CodeRay">
|
||
<div class="code"><pre>$ sudo pip3 install homeassistant
|
||
$ hass
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
|
||
<p>Running these commands will:</p>
|
||
|
||
<ul>
|
||
<li>Install Home Assistant</li>
|
||
<li>Launch Home Assistant and serve the web interface on <a href="http://localhost:8123">http://localhost:8123</a></li>
|
||
</ul>
|
||
|
||
<p>There is also a <a href="https://www.youtube.com/watch?v=GjzOXkPb7XE">video tutorial</a> created by <a href="https://github.com/brusc">brusc</a>.</p>
|
||
|
||
</div> <!-- INSTALL-INSTRUCTIONS RASPBERRY -->
|
||
|
||
<div class="install-instructions synology">
|
||
|
||
<p>The following configuration has been tested on Synology 415+ running DSM 5.2-5644 Update 3.</p>
|
||
|
||
<p>Running these commands will:</p>
|
||
|
||
<ul>
|
||
<li>Install Home Assistant</li>
|
||
<li>Enable Home Assistant to be launched on <a href="http://localhost:8123">http://localhost:8123</a></li>
|
||
</ul>
|
||
|
||
<p>Using the Synology webadmin:</p>
|
||
|
||
<ul>
|
||
<li>Install python3 using the Synology package centre</li>
|
||
<li>Create homeassistant user and add to the “users” group</li>
|
||
</ul>
|
||
|
||
<p>SSH onto your synology & login as admin or root</p>
|
||
|
||
<p>Check the path to python3 (assumed to be /usr/local/python3/bin)</p>
|
||
|
||
<div class="highlighter-coderay"><div class="CodeRay">
|
||
<div class="code"><pre>$ cd /usr/local/python3/bin
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
|
||
<p>Use PIP to install Homeassistant package</p>
|
||
|
||
<div class="highlighter-coderay"><div class="CodeRay">
|
||
<div class="code"><pre>$ pip3 install homeassistant
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
|
||
<p>Create homeassistant config directory & switch to it</p>
|
||
|
||
<div class="highlighter-coderay"><div class="CodeRay">
|
||
<div class="code"><pre>$ mkdir /volume1/homeassistant
|
||
$ cd /volume1/homeassistant
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
|
||
<p>Create hass-daemon file using the following code (edit the variables in uppercase if necessary)</p>
|
||
|
||
<div class="highlighter-coderay"><div class="CodeRay">
|
||
<div class="code"><pre>#!/bin/sh
|
||
|
||
# Package
|
||
PACKAGE="homeassistant"
|
||
DNAME="Home Assistant"
|
||
|
||
# Others
|
||
USER="homeassistant"
|
||
PYTHON_DIR="/usr/local/python3/bin"
|
||
PYTHON="$PYTHON_DIR/python3"
|
||
HASS="$PYTHON_DIR/hass"
|
||
INSTALL_DIR="/volume1/homeassistant"
|
||
PID_FILE="$INSTALL_DIR/home-assistant.pid"
|
||
FLAGS="-v --config $INSTALL_DIR --pid-file $PID_FILE --daemon"
|
||
REDIRECT="> $INSTALL_DIR/home-assistant.log 2>&1"
|
||
|
||
start_daemon ()
|
||
{
|
||
su ${USER} -s /bin/sh -c "$PYTHON $HASS $FLAGS $REDIRECT;"
|
||
}
|
||
|
||
stop_daemon ()
|
||
{
|
||
kill `cat ${PID_FILE}`
|
||
wait_for_status 1 20 || kill -9 `cat ${PID_FILE}`
|
||
rm -f ${PID_FILE}
|
||
}
|
||
|
||
daemon_status ()
|
||
{
|
||
if [ -f ${PID_FILE} ] && kill -0 `cat ${PID_FILE}` > /dev/null 2>&1; then
|
||
return
|
||
fi
|
||
rm -f ${PID_FILE}
|
||
return 1
|
||
}
|
||
|
||
wait_for_status ()
|
||
{
|
||
counter=$2
|
||
while [ ${counter} -gt 0 ]; do
|
||
daemon_status
|
||
[ $? -eq $1 ] && return
|
||
let counter=counter-1
|
||
sleep 1
|
||
done
|
||
return 1
|
||
}
|
||
|
||
case $1 in
|
||
start)
|
||
if daemon_status; then
|
||
echo ${DNAME} is already running
|
||
exit 0
|
||
else
|
||
echo Starting ${DNAME} ...
|
||
start_daemon
|
||
exit $?
|
||
fi
|
||
;;
|
||
stop)
|
||
if daemon_status; then
|
||
echo Stopping ${DNAME} ...
|
||
stop_daemon
|
||
exit $?
|
||
else
|
||
echo ${DNAME} is not running
|
||
exit 0
|
||
fi
|
||
;;
|
||
restart)
|
||
if daemon_status; then
|
||
echo Stopping ${DNAME} ...
|
||
stop_daemon
|
||
echo Starting ${DNAME} ...
|
||
start_daemon
|
||
exit $?
|
||
else
|
||
echo ${DNAME} is not running
|
||
echo Starting ${DNAME} ...
|
||
start_daemon
|
||
exit $?
|
||
fi
|
||
;;
|
||
status)
|
||
if daemon_status; then
|
||
echo ${DNAME} is running
|
||
exit 0
|
||
else
|
||
echo ${DNAME} is not running
|
||
exit 1
|
||
fi
|
||
;;
|
||
log)
|
||
echo ${LOG_FILE}
|
||
exit 0
|
||
;;
|
||
*)
|
||
exit 1
|
||
;;
|
||
esac
|
||
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
|
||
<p>Create links to python folders to make things easier in the future:</p>
|
||
|
||
<div class="highlighter-coderay"><div class="CodeRay">
|
||
<div class="code"><pre>$ ln -s /usr/local/python3/bin python3
|
||
$ ln -s /usr/local/python3/lib/python3.4/site-packages/homeassistant
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
|
||
<p>Set the owner and permissions on your config folder</p>
|
||
|
||
<div class="highlighter-coderay"><div class="CodeRay">
|
||
<div class="code"><pre>$ chown -r homeassistant:users /volume1/homeassistant
|
||
$ chmod -r 660 /volume1/homeassistant
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
|
||
<p>Make the daemon file executable:</p>
|
||
|
||
<div class="highlighter-coderay"><div class="CodeRay">
|
||
<div class="code"><pre>$ chmod -r 777 /volume1/homeassistant/hass-daemon
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
|
||
<p>Copy your configuration.yaml file into the config folder
|
||
That’s it… you’re all set to go</p>
|
||
|
||
<p>Here are some useful commands:</p>
|
||
|
||
<ul>
|
||
<li>Start Home Assistant:</li>
|
||
</ul>
|
||
|
||
<div class="highlighter-coderay"><div class="CodeRay">
|
||
<div class="code"><pre>$ sh hass-daemon start
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
|
||
<ul>
|
||
<li>Stop Home Assistant:</li>
|
||
</ul>
|
||
|
||
<div class="highlighter-coderay"><div class="CodeRay">
|
||
<div class="code"><pre>$ sh hass-daemon stop
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
|
||
<ul>
|
||
<li>Restart Home Assistant:</li>
|
||
</ul>
|
||
|
||
<div class="highlighter-coderay"><div class="CodeRay">
|
||
<div class="code"><pre>$ sh hass-daemon restart
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
|
||
<ul>
|
||
<li>Upgrade Home Assistant::</li>
|
||
</ul>
|
||
|
||
<div class="highlighter-coderay"><div class="CodeRay">
|
||
<div class="code"><pre>$ python3/pip3 install --upgrade homeassistant
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
|
||
</div> <!-- INSTALL-INSTRUCTIONS SYNOLOGY -->
|
||
</div>
|
||
|
||
<h3><a class="title-link" name="troubleshooting" href="#troubleshooting"></a> Troubleshooting</h3>
|
||
|
||
<p>If you run into any issues, please see <a href="/getting-started/troubleshooting/">the troubleshooting page</a>. It contains solutions to many of the more commonly encountered issues.</p>
|
||
|
||
<p>For additional help, in addition to this site, there are four sources:</p>
|
||
|
||
<ul>
|
||
<li><a href="https://automic.us/forum/">Forum</a></li>
|
||
<li><a href="https://gitter.im/balloob/home-assistant">Gitter Chatroom</a> for general Home Assistant discussions and questions.</li>
|
||
<li><a href="https://github.com/balloob/home-assistant/issues">GitHub Page</a> for issue reporting.</li>
|
||
</ul>
|
||
|
||
<h3>Updating</h3>
|
||
<p>To update Home Assistant to the latest release run: <code>pip3 install --upgrade homeassistant</code> <br />
|
||
You then have to restart Home Assistant for the changes to take effect. If you have installed it as an autostarting daemon (see below), then run: <code>sudo service hass-daemon restart</code></p>
|
||
|
||
<h3>What’s next</h3>
|
||
<p>If you want to have Home Assistant start on boot, autostart instructions can be found <a href="/getting-started/autostart/">here</a>.</p>
|
||
|
||
<p>To see what Home Assistant can do, launch demo mode: <code>hass --demo-mode</code> or visit the <a href="/demo">demo page</a>.</p>
|
||
|
||
<h3><a href="/getting-started/configuration/">Next step: Configuring Home Assistant »</a></h3>
|
||
|
||
|
||
</article>
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
|
||
<footer>
|
||
<div class="grid-wrapper">
|
||
<div class="grid">
|
||
<div class="grid__item">
|
||
<div class="copyright">
|
||
<a rel="me" href='https://twitter.com/home_assistant'><i class="icon-twitter"></i></a>
|
||
<a rel="me" href='https://github.com/balloob/home-assistant'><i class="icon-github"></i></a>
|
||
|
||
<div class="credit">
|
||
Website powered by <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>.<br />
|
||
Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.
|
||
</div>
|
||
</div>
|
||
</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> |