mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-23 09:17:06 +00:00
Revamp getting started (#4194)
* Revamp getting started * Comments by Landrash * Add text editor to software requirements * Address comments
This commit is contained in:
Paulus Schoutsen
Fabian Affolter
parent
a835d5feda
commit
15e3857184
@ -14,9 +14,21 @@ redirect_from: /getting-started/installation/
|
||||
Beginners should check our [Getting started guide](/getting-started/) first. This is for users that require advanced installations.
|
||||
</p>
|
||||
|
||||
Home Assistant provides multiple ways to be installed. A requirement is that you have [Python](https://www.python.org/downloads/) installed. For Windows, we require at least **Python 3.5** and for other operating systems at least **Python 3.4.2**.
|
||||
Home Assistant provides multiple ways to be installed. A requirement is that you have [Python 3.5+](https://www.python.org/downloads/) installed.
|
||||
|
||||
<div class="text-center hass-option-cards" markdown="0">
|
||||
<a class='option-card' href='/getting-started/'>
|
||||
<div class='img-container'>
|
||||
<img src='/images/supported_brands/home-assistant.png' />
|
||||
</div>
|
||||
<div class='title'>Hass.io<br>(Beginner friendly)</div>
|
||||
</a>
|
||||
<a class='option-card' href='/docs/installation/virtualenv/'>
|
||||
<div class='img-container'>
|
||||
<img src='/images/supported_brands/python.svg' />
|
||||
</div>
|
||||
<div class='title'>On top of an existing Python 3.5+ installation</div>
|
||||
</a>
|
||||
<a class='option-card' href='/docs/hassbian/installation/'>
|
||||
<div class='img-container'>
|
||||
<img src='/images/supported_brands/home-assistant.png' />
|
||||
|
||||
@ -9,19 +9,59 @@ sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
When launched for the first time, Home Assistant will write a default configuration file, called `configuration.yaml`, enabling the web interface and [device discovery](/components/discovery/). It can take up to a minute for your devices to be discovered and appear in the user interface.
|
||||
If you made it here, awesome! That means that you got Home Assistant up and running. It might have already found some of your networked devices. This is going to be fun!
|
||||
|
||||
The `configuration.yaml` is written in [YAML](/docs/configuration/yaml/), stored in [`.homeassistant`](/docs/configuration/), and can be modified with a text editor.
|
||||
Home Assistant stores its configuration in a file called `configuration.yaml`. A default one is created when Home Assistant is started for the first time. Some of the things in the configuration file can be edited via the user interface, other parts require you to edit the configuration file directly.
|
||||
|
||||
See the [components overview page](/components/) to find sample entries for your devices and services. For a sensor that is showing [random values](/components/sensor.random/), the entry would look like the sample below:
|
||||
There are two common approaches to edit your configuration: via Samba/Windows Networking and via the HASS Configurator. Both of these are [official add-ons for Hass.io](/addons/).
|
||||
|
||||
## {% linkable_title Installing Hass.io add-ons %}
|
||||
|
||||
Hass.io add-ons are installed from the add-on store embedded in the Hass.io panel:
|
||||
|
||||
- Open Home Assistant by navigating to [http://hassio.local:8123][local].
|
||||
- Click on the menu icon in the top left and select Hass.io in the sidebar.
|
||||
- The Hass.io panel opens, now open the add-on store by clicking the shopping bag.
|
||||
|
||||
[local]: http://hassio.local:8123
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/hassio/screenshots/main_panel_store_icon.png' />
|
||||
From the Hass.io main panel open the add-on store.
|
||||
</p>
|
||||
|
||||
### {% linkable_title Editing config via HASS Configurator %}
|
||||
|
||||
The first add-on we should install is the HASS Configurator. With the HASS Configurator you'll be able to edit your Home Assistant configuration from the web interface.
|
||||
|
||||
Go to the add-on store (see previous step), click on Configurator and click on INSTALL. When installation is complete the UI will go to the add-on details page for the configurator. Here you will be able to change settings, start and stop the add-on.
|
||||
|
||||
- Change the settings to set a password and click on save
|
||||
- Start the add-on
|
||||
- You will be able to click the "WEB UI" link to open the Web UI
|
||||
|
||||
Time for the first practice with the configurator. Add the following to `configuration.yaml` file to add a link to the Configurator in the sidebar:
|
||||
|
||||
```yaml
|
||||
sensor:
|
||||
- platform: random
|
||||
panel_iframe:
|
||||
configurator:
|
||||
title: Configurator
|
||||
icon: mdi:wrench
|
||||
url: http://hassio.local:3218
|
||||
```
|
||||
|
||||
The [Setting up devices part](/docs/configuration/devices/) contains the additional documentation details about adding devices and services and [customization](/docs/configuration/customizing-devices/).
|
||||
Now restart Home Assistant for the changes to the configuration to take effect. You can do this by going to the config panel (Configuration in the sidebar) -> General -> Restart Home Assistant.
|
||||
|
||||
For further details about configuration, please take a look at the [configuration documentation](/docs/configuration/).
|
||||
### {% linkable_title Editing config via Samba/Windows Networking %}
|
||||
|
||||
Maybe you are not a big fan of our web editor and want to use a text editor on your computer instead. This is possible by sharing the configuration over the network using the Samba add-on, which can be installed from the Hass.io add-on store.
|
||||
|
||||
After you have installed it, click on START. Hass.io should now be available in the networking tab on your computer. Use a text editor like the free [Visual Studio Code](https://code.visualstudio.com/) to edit `configuration.yaml`.
|
||||
|
||||
## {% linkable_title Configuring integrations %}
|
||||
|
||||
Now that you are able to edit the configuration, it's time to set up some of your devices and services. Each service and device will have its own instructions on how to be integrated. Find your devices and services on the [components overview page](/components/).
|
||||
|
||||
<p class='note'>YAML can be a little daunting at first. A lot is possible! [Here is some more info.](/docs/configuration/devices/)</p>
|
||||
|
||||
### [Next step: Automate Home Assistant »](/getting-started/automation/)
|
||||
|
||||
@ -9,30 +9,39 @@ sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
First you will need to install Home Assistant before we can get started:
|
||||
The goal of this getting started guide is to install Hass.io on a Raspberry Pi 3. Hass.io is our own all in one solution that turns your Raspberry PI into the utlimate home automation hub.
|
||||
|
||||
We have developed **Hass.io** to turn your device into a dedicated Home Assistant hub controlled by a nice webinterface.
|
||||
For Raspberry Pi and Intel NUC we offer configured images. Flash the image, setup WiFi (if required) and everything else can be done inside the Hass.io webinterface. Great, isn't it?
|
||||
Follow this guide if you want to easily get started with Home Assistant or if you have none or little Linux experience. For advanced users, check our [alternative installation methods](/docs/installation/).
|
||||
|
||||
Also Home Assistant runs on any other device that supports **Python 3**.
|
||||
<div class="text-center hass-option-cards" markdown="0">
|
||||
<a class='option-card' href='/hassio/installation/'>
|
||||
<div class='img-container'>
|
||||
<img src='/images/supported_brands/home-assistant.png' />
|
||||
</div>
|
||||
<div class='title'>Install Home Assistant using Hass.io</div>
|
||||
</a>
|
||||
<a class='option-card' href='/docs/installation/virtualenv/'>
|
||||
<div class='img-container'>
|
||||
<img src='/images/supported_brands/python.svg' />
|
||||
</div>
|
||||
<div class='title'>Install Home Assistant on your computer</div>
|
||||
</a>
|
||||
</div>
|
||||
<br>
|
||||
### {% linkable_title Hardware requirements %}
|
||||
|
||||
For alternative installation methods, please take a look at the [installation documentation](/docs/installation/).
|
||||
We will need a few things to get started with installing Home Assistant. Links below are linking to Amazon US. If you're not in the US, you should be able to find these items in web stores in your country.
|
||||
|
||||
If you run into any issues, please see [the troubleshooting page](/docs/installation/troubleshooting/) or [communication channels](/help/). It contains solutions to many commonly encountered issues.
|
||||
- [Raspberry Pi 3 model B](http://a.co/gEfMqL4) + [Power Supply](http://a.co/cgKUgkt) (atleast 2.5A)
|
||||
- [Micro SD Card](http://a.co/gslOydD). Get one that is Class 10 as they are more reliable. Size 32GB or bigger recommended.
|
||||
- SD Card reader. Part of most laptops. Also available as [standalone USB sticks](http://a.co/5FCyb0N) (brand doesn't matter, just pick cheapest)
|
||||
- Ethernet cable (optional, Hass.io can work with WiFi too)
|
||||
|
||||
### {% linkable_title Software requirements %}
|
||||
|
||||
- Download [Hass.io image for Raspberry Pi 3][pi3]
|
||||
- Download [Etcher] to write the image to an SD card
|
||||
- Text Editor like [Visual Studio Code](https://code.visualstudio.com/)
|
||||
|
||||
[Etcher]: https://etcher.io/
|
||||
[pi3]: https://github.com/home-assistant/hassio-build/releases/download/1.1/resinos-hassio-1.1-raspberrypi3.img.bz2
|
||||
|
||||
### Installing Hass.io
|
||||
|
||||
1. Put the SD card in your SD card reader,
|
||||
2. Open Etcher, select the Hass.io image and flash it to the SD card.
|
||||
3. WiFi setup only: open the file `system-connections/resin-sample` with a text editor. Change `ssid` to be your network name and `psk` to be your password.
|
||||
4. Unmount the SD card and remove it from your SD card reader.
|
||||
5. Insert the SD card into your Raspberry Pi 3. If you are going to use an Ethernet cable to supply Internet, connect that too.
|
||||
6. Connect your Raspberry Pi to the power supply so it turns on.
|
||||
7. The Raspberry Pi will now boot up, connect to the Internet and download the latest version of Home Assistant. This will take about 20 minutes.
|
||||
8. Home Assistant will be available at [http://hassio.local:8123][local].
|
||||
|
||||
[local]: http://hassio.local:8123
|
||||
|
||||
### [Next step: Configuring Home Assistant »](/getting-started/configuration/)
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user