diff --git a/source/_includes/asides/getting_started_navigation.html b/source/_includes/asides/getting_started_navigation.html index 9d41bb402b1..771a222c91b 100644 --- a/source/_includes/asides/getting_started_navigation.html +++ b/source/_includes/asides/getting_started_navigation.html @@ -2,14 +2,14 @@ {% include edit_github.html %}
+
+The automation editor.
+
+
+A new automation with a sun trigger filled in.
+
+
+A new automation with the action set up to turn on the lights.
+
-This guide applies only if you've installed Home Assistant via Hass.io. If you've used any other install method then [see here](/docs/configuration/) instead. +Until now we have been able to configure Home Assistant purely via the user interface. However, not all options are accessible via the user interface. The other options are accessible via the Home Assistant configuration file called `configuration.yaml`. A default one is created when Home Assistant started for the first time. + +
+This final step of the getting started only applies if you've installed Home Assistant via Hass.io. If you've used another installation method, [see here](/docs/configuration/).
-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! - -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. - -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 +We are going to help you make your first changes to `configuration.yaml`. To do this, we are going to install an add-on from the Hass.io add-on store: the HASS Configurator. To get to the add-on store, click on the menu icon in the top left, then click on Hass.io. On the new page, open the add-on store tab.
-From the Hass.io main panel open the add-on store.
+From the Hass.io main panel, open the add-on store.
+
+Screenshot of the "General" page in the configuration panel.
+
YAML can be a little daunting at first. A lot is possible! [Here is some more info.](/docs/configuration/devices/)
- -For your first integration, you'll create a virtual sensor that generates a random integer value between 0 and 20 every 30 seconds. - -To create this random value sensor [random values](/components/sensor.random/), enter the following to the bottom of your `configuration.yaml` file, and restart Home Assistant (remember it may take up to a minute for the service to restart): - -```yaml -sensor: - - platform: random -``` - -You'll know it worked when you see the new random sensor in your overview page. On the next page, we'll create an automation that uses this sensor to take an action. - -### [Next step: Automate Home Assistant »](/getting-started/automation/) +We suggest that to edit `configuration.yaml`, you use the free text editor [Visual Studio Code](https://code.visualstudio.com/) in combination with the [Home Assistant Config Helper extension](https://marketplace.visualstudio.com/items?itemName=keesschollaart.vscode-home-assistant). diff --git a/source/getting-started/index.markdown b/source/getting-started/index.markdown index eade77a5557..7635cb1c396 100644 --- a/source/getting-started/index.markdown +++ b/source/getting-started/index.markdown @@ -9,29 +9,47 @@ sharing: true footer: true --- -The goal of this getting started guide is to install [Hass.io](/hassio/) on a Raspberry Pi. Hass.io is our own all in one solution that turns your Raspberry Pi or another device into the ultimate home automation hub. +{% comment %} -Follow this guide if you want to get started with Home Assistant easily, or if you have no or little Linux experience. +Note for contributors: --For advanced users or if you have no Raspberry Pi at hand, check our [alternative installation methods](/docs/installation/). The [FAQ](/faq/#home-assistant-vs-hassio) explains more about the differences. -
+The getting started guide aims at getting new users get Home Assistant up and +running as fast as possible. Nothing else. All other things should not be +written down, as it creates a spaghetti of links and the user will lose focus. + +So here are guidelines: + + - Focus on the bare necessities. No remote port, no securing installation. The + defaults are good enough to get a system up and running for the first guide. + - Avoid or explain technical terms. + - Do not talk about YAML if it can be partially/fully done in UI. + - Do not tell people about stuff they can do later. This can be added to a + 2nd tier guide. + - The first page of the guide is for installation, hence hass.io specific. + Other pages should not refer to it except for the page introducing the last + page that introduces `configuration.yaml`. + +{% endcomment %} + +The goal of this getting started guide is to get Home Assistant running on a Raspberry Pi. The easiest way to do this is by using [Hass.io](/hassio/, which is our own all in one solution that turns Raspberry Pi's and another devices into the ultimate home automation hubs. + +Follow this guide if you want to get started with Home Assistant easily, or if you have no or little Linux experience. For advanced users or if you don't have a [device that is supported by this guide][supported], check our [alternative installation methods](/docs/installation/). Once you finish your alternative installation, you can continue at the [next step][next-step]. + +[supported]: /hassio/installation/ ### {% linkable_title Suggested hardware%} -We will need a few things to get started with installing Home Assistant. For best performance, we suggest the latest Raspberry Pi 3 Model B+. 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. +We will need a few things to get started with installing Home Assistant. The latest Raspberry Pi model makes a good and affordable starting point for your home automation journey. 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. - [Raspberry Pi 3 Model B+](http://a.co/ak2SQor) + [Power Supply](https://www.raspberrypi.org/help/faqs/#powerReqs) (at least 2.5A) - [Micro SD Card](http://a.co/gslOydD). Get one that is Class 10 as they are more reliable. Size 32 GB or bigger recommended. - SD Card reader. Part of most laptops, and also available as [standalone USB sticks](http://a.co/5FCyb0N) (the brand doesn't matter, just pick the cheapest) - Ethernet cable (optional, Hass.io can work with WiFi as well) -- A USB-Stick (optional, allows for unattended configuration) ### {% linkable_title Software requirements %} - Download the Hass.io image for [your device](/hassio/installation/) - Download [balenaEtcher] to write the image to an SD card -- Text Editor like [Visual Studio Code](https://code.visualstudio.com/) [balenaEtcher]: https://www.balena.io/etcher @@ -39,29 +57,23 @@ We will need a few things to get started with installing Home Assistant. For bes 1. Put the SD card in your SD card reader. 1. Open balenaEtcher, select the Hass.io image and flash it to the SD card. -1. WiFi and Static IP setup only: +1. Unmount the SD card and remove it from your SD card reader. +1. Only if you want to configure WiFi or a Static IP (requires USB stick): - Format a USB-Stick to FAT32 with volume-name `CONFIG`. - Create a folder named `network` in the root of the newly formatted USB-stick. - Within that folder create a file named `my-network` without extension. - - Copy one of [the examples] to the `my-network` file. + - Copy one of [the examples] to the `my-network` file and adjust accordingly. - Plug the USB-stick into the Raspberry Pi 3. -1. Unmount the SD card and remove it from your SD card reader. + 1. Insert the SD card into your Raspberry Pi 3. If you are going to use an Ethernet cable, connect that too. 1. Connect your Raspberry Pi to the power supply, so it turns on. 1. The Raspberry Pi will now boot up, connect to the Internet and download the latest version of Home Assistant, which will take about 20 minutes. -1. Home Assistant will be available at [http://hassio.local:8123][local]. Shortly after the download has started, a simple preparation status page will be available at this URL. Point your browser there. The page refreshes automatically, and Home Assistant will be shown when the download is complete (this typically takes around 20 minutes). -1. Please remember to [secure your installation][secure] once you've finished with the installation process. +1. Home Assistant will be available at [http://hassio.local:8123][local]. If you are running an older Windows or have stricter network configuration, you might need to access Home Assistant at [http://hassio:8123][host]. [local]: http://hassio.local:8123 +[host]: http://hassio:8123 [the examples]: https://github.com/home-assistant/hassos/blob/dev/Documentation/network.md -[secure]: /docs/configuration/securing/ --If your router doesn't support mDNS, then you'll have to use the IP address of your Pi instead of `hassio.local`. For example, `http://192.168.0.9:8123`. You should be able to find the IP address of your Pi from the admin interface of your router. -
+### [Next step: Onboarding »][next-step] --When you're done, remember to set up regular backups of your configuration. These backups will protect you from hardware failure and mistakes. On Hass.io you have snapshots (which you should copy off to another system), but you can back up to [GitHub](/docs/ecosystem/backup/backup_github/), [DropBox](/docs/ecosystem/backup/backup_dropbox/) and many other ways. All that matters is that you set them up and test them regularly. -
- -### [Next step: Configuring Home Assistant »](/getting-started/configuration/) +[next-step]: /getting-started/onboarding/ diff --git a/source/getting-started/join-the-community.markdown b/source/getting-started/join-the-community.markdown new file mode 100644 index 00000000000..4b3afcf04d0 --- /dev/null +++ b/source/getting-started/join-the-community.markdown @@ -0,0 +1,24 @@ +--- +layout: page +title: "Join the Community" +description: "Part of the Home Assistant experience is the large world-wide community of tinkerers. Join us." +date: 2019-04-19 00:01 +sidebar: true +comments: false +sharing: true +footer: true +--- + +You made it here? Good job! You've been able to install Home Assistant and get a small taste of all the things that are possible. + +Now that you've got that going, let's see what is next: + + - Learn about [advanced configuration](/getting-started/configuration/) using `configuration.yaml` in our bonus step of the getting started guide. + - Join the community in [our forums] or [our chat]. + - Check out [video tutorials] on a wide range of Home Assistant related topics + +You're now ready to be a part of our world-wide community of tinkerers. Welcome! + +[our forums]: https://community.home-assistant.io/ +[our chat]: /join-chat/ +[video tutorials]: https://www.youtube.com/results?search_query=home+assistant diff --git a/source/getting-started/onboarding.markdown b/source/getting-started/onboarding.markdown new file mode 100644 index 00000000000..80fbe7013e1 --- /dev/null +++ b/source/getting-started/onboarding.markdown @@ -0,0 +1,29 @@ +--- +layout: page +title: "Onboarding Home Assistant" +description: "Instructions to get Home Assistant configured." +date: 2019-04-19 00:01 +sidebar: true +comments: false +sharing: true +footer: true +--- + +Alright, you made it here. The tough part is done. + +With Home Assistant installed, it's time for doing the initial configuration. Here you will create the owner account of Home Assistant. This account will be an administrator and will always be able to change everything. Enter a name, username, password and click on "create account". + +Now you're brought to the main screen of Home Assistant: the states screen. The states screen will show all your devices. So let's get that screen filled up! + +Open the menu on the top left and click on Configuration. On the next screen, click on Integrations. At this screen you will be able to set up integrations with Home Assistant. You might notice a "discovered" section, these are integrations that we found on your network and can easily be added with a few clicks. If your integrations are not discovered, find them in the list and click on configure. + +
+
+The integrations page in the configurations panel shows you all your configured integrations.
+
-We care about privacy. Collected data is only stored in your instance of Home Assistant. -
- Presence detection detects if people are home, which is the most valuable input for automation. Knowing who is home or where they are, will open a whole range of other automation options: - Send me a notification when my child arrives at school @@ -23,34 +19,31 @@ Presence detection detects if people are home, which is the most valuable input Screenshot of Home Assistant showing a school, work and home zone and two people. -### {% linkable_title Setting it up %} +### {% linkable_title Adding presence detection %} -The device tracker component offers presence detection for Home Assistant. It supports three different methods for presence detection: scan for connected devices on the local network, scan for Bluetooth devices within range, and connect to third-party service. +There are different ways of setting up presence detection. Usually the easiest way to detect presence is by checking which devices are connected to the network. You can do that if you have one of our [supported routers][routers]. By leveraging what your router already knows, you can easily detect if people are at home. -Scanning for connected devices is easy to setup; options include [supported routers][routers] and [scanning the network using Nmap][nmap]. This approach does have its limitations, however: it will only be able to detect if a device is at home, and modern smartphones may show as not home inaccurately (as they disconnect from WiFi if idle). +It's also possible to run an app on your phone to provide detailed location information to your Home Assistant instance. If you're on iOS we suggest to use the [Home Assistant iOS app](/ios/). For Android, we suggest [OwnTracks][ha-owntracks]. -You can scan for [Bluetooth][ha-bluetooth] and [Bluetooth LE][ha-bluetooth-le] devices. Unlike with WiFi, modern smartphones don't turn off Bluetooth automatically, though the range is lower. - -Home Assistant currently supports multiple third-party services for presence detection, such as [OwnTracks over MQTT][ha-owntracks-mqtt], [OwnTracks over HTTP][ha-owntracks-http] [GPSLogger][ha-gpslogger] and [Locative][ha-locative]. - -There is a wide [range of options][ha-presence] available, both for scanning your local network and third-party services. +-If you're looking at the [map view][ha-map] then any devices in your Home zone won't be visible, this is by design. +The map view will hide all devices that are home.
[routers]: /components/#presence-detection [nmap]: /components/device_tracker.nmap_tracker/ [ha-bluetooth]: /components/device_tracker.bluetooth_tracker/ [ha-bluetooth-le]: /components/device_tracker.bluetooth_le_tracker/ -[ha-owntracks-mqtt]: /components/device_tracker.owntracks/ -[ha-owntracks-http]: /components/device_tracker.owntracks_http/ +[ha-owntracks]: /components/owntracks/ [ha-locative]: /components/device_tracker.locative/ [ha-gpslogger]: /components/device_tracker.gpslogger/ [ha-presence]: /components/#presence-detection @@ -61,4 +54,4 @@ If you're looking at the [map view][ha-map] then any devices in your Home zone w [condition]: /getting-started/automation-condition/#zone-condition [ha-map]: /components/map/ -### [Next step: Use Home Assistant »](/getting-started/use/) +### [Next step: Join the Community »](/getting-started/join-the-community/) diff --git a/source/getting-started/use.markdown b/source/getting-started/use.markdown deleted file mode 100644 index 941d78e02df..00000000000 --- a/source/getting-started/use.markdown +++ /dev/null @@ -1,22 +0,0 @@ ---- -layout: page -title: "Manage Home Assistant" -description: "Instructions about how to manage Home Assistant." -date: 2016-09-26 21:00 -sidebar: true -comments: false -sharing: true -footer: true ---- - -If you are using Hassbian, browse to [http://hassbian.local:8123](http://hassbian.local:8123) to open the Home Assistant frontend. - -To reload your configuration, go to **Configuration** in your side panel and choose "CHECK CONFIG". - -You will have to restart Home Assistant for most changes to `configuration.yaml` to take effect. You can load changes to [automations](/docs/automation/), [customize](/docs/configuration/customizing-devices/), [groups](/components/group/), and [scripts](/components/script/) without restarting. - -
-
-