diff --git a/source/_includes/installation/operating_system.md b/source/_includes/installation/operating_system.md index 4bfacd56be6..030f0cd4816 100644 --- a/source/_includes/installation/operating_system.md +++ b/source/_includes/installation/operating_system.md @@ -6,20 +6,6 @@ Follow this guide if you want to get started with Home Assistant easily or if you have little to no Linux experience. -{% if page.installation_type == 'raspberrypi' %} - -### Suggested Hardware - -We will need a few things to get started with installing Home Assistant. Links below lead 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 4](https://amzn.to/2S0Gcl1) (Raspberry Pi 3 is ok too, if you have one laying around). Raspberry Pi are currently hard to come by, use [RPilocator](https://rpilocator.com/?cat=PI4) to find official distributors with stock. -- [Power Supply for Raspberry Pi 4](https://amzn.to/2ReZ2Vq) or [Power Supply for Raspberry Pi 3](https://amzn.to/2R8yG7h) -- [Micro SD Card](https://amzn.to/2X0Z2di). Ideally get one that is [Application Class 2](https://www.sdcard.org/developers/overview/application/index.html) as they handle small I/O much more consistently than cards not optimized to host applications. A 32 GB or bigger card is recommended. -- SD Card reader. This is already part of most laptops, but you can purchase a [standalone USB adapter](https://amzn.to/2WWxntY) if you don't have one. The brand doesn't matter, just pick the cheapest. -- [Ethernet cable](https://amzn.com/dp/B00N2VISLW). Required for installation. After installation, Home Assistant can work with Wi-Fi, but an Ethernet connection is more reliable and highly recommended. - -{% endif %} - {% if page.installation_type == 'odroid' %} ### Suggested Hardware diff --git a/source/images/installation/rpi-imager-start.png b/source/images/installation/rpi-imager-start.png new file mode 100644 index 00000000000..f5b6cf2e3d2 Binary files /dev/null and b/source/images/installation/rpi-imager-start.png differ diff --git a/source/images/installation/rpi-select-os.png b/source/images/installation/rpi-select-os.png new file mode 100644 index 00000000000..fc3635d7ee8 Binary files /dev/null and b/source/images/installation/rpi-select-os.png differ diff --git a/source/images/installation/rpi-select-sd-card.png b/source/images/installation/rpi-select-sd-card.png new file mode 100644 index 00000000000..a17cca6dfcf Binary files /dev/null and b/source/images/installation/rpi-select-sd-card.png differ diff --git a/source/images/installation/rpi-select-write.png b/source/images/installation/rpi-select-write.png new file mode 100644 index 00000000000..918f5971085 Binary files /dev/null and b/source/images/installation/rpi-select-write.png differ diff --git a/source/images/installation/rpi_imager.png b/source/images/installation/rpi_imager.png new file mode 100644 index 00000000000..5fd86c73b23 Binary files /dev/null and b/source/images/installation/rpi_imager.png differ diff --git a/source/installation/raspberrypi.markdown b/source/installation/raspberrypi.markdown index dc3f3a1f5a9..7453c01c4e4 100644 --- a/source/installation/raspberrypi.markdown +++ b/source/installation/raspberrypi.markdown @@ -16,8 +16,103 @@ Please remember to ensure you're using an [appropriate power supply](https://www -{% include installation/operating_system.md %} +## Suggested Hardware + +We will need a few things to get started with installing Home Assistant. Links below lead 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 4](https://amzn.to/2S0Gcl1) (Raspberry Pi 3 is ok too, if you have one laying around). Raspberry Pi are currently hard to come by, use [RPilocator](https://rpilocator.com/?cat=PI4) to find official distributors with stock. +- [Power Supply for Raspberry Pi 4](https://amzn.to/2ReZ2Vq) or [Power Supply for Raspberry Pi 3](https://amzn.to/2R8yG7h) +- [Micro SD Card](https://amzn.to/2X0Z2di). Ideally get one that is [Application Class 2](https://www.sdcard.org/developers/overview/application/index.html) as they handle small I/O much more consistently than cards not optimized to host applications. A 32 GB or bigger card is recommended. +- SD Card reader. This is already part of most laptops, but you can purchase a [standalone USB adapter](https://amzn.to/2WWxntY) if you don't have one. The brand doesn't matter, just pick the cheapest. +- [Ethernet cable](https://amzn.com/dp/B00N2VISLW). Required for installation. After installation, Home Assistant can work with Wi-Fi, but an Ethernet connection is more reliable and highly recommended. + +## Install Home Assistant Operating System + +This guide shows how to install the Home Assistant Operating system onto your Raspberry Pi using Raspberry Pi Imager. + +If Raspberry Pi Imager is not supported by your platform, you can use [Balena Etcher](#writing-the-image-with-balena-etcher) instead. + +### Write the image to your SD card + +1. Install the Raspberry Pi Imager on your computer as described under [https://www.raspberrypi.com/software/](https://www.raspberrypi.com/software/). + ![Install Raspberry Pi Imager](/images/installation/rpi_imager.png) +1. Open the Raspberry Pi Imager. + ![Open Raspberry Pi Imager](/images/installation/rpi-imager-start.png) +1. Choose the operating system: + ![Choose the operating system](/images/installation/rpi-select-os.png) + 1. Select **Choose OS**. + 1. Select **Home assistants and home automation**. + 1. Choose the Home Assistant OS that matches your hardware (RPi 3 or RPi 4). +1. Choose the storage: + 1. Insert the SD card into the computer. Note: the contents of the card will be overwritten. + 1. Select your SD card. + ![Select the storage](/images/installation/rpi-select-sd-card.png) +1. Write the installer onto the SD card: + 1. To start the process, select **Write**. + 1. Wait for the Home Assistant OS to be written to the SD card. + ![Select write](/images/installation/rpi-select-write.png) +1. Eject the SD card. + +### Start up your Raspberry Pi + +1. Insert the SD card into your Raspberry Pi. +1. Plug in an Ethernet cable that is connected to the network. +1. Connect the power supply to start up the device. + +1. In the browser of your desktop system, within a few minutes you will be able to reach your new Home Assistant at homeassistant.local:8123. + +
+If you are running an older Windows version or have a stricter network configuration, you might need to access Home Assistant at homeassistant:8123 or `http://X.X.X.X:8123` (replace X.X.X.X with your Raspberry Pi’s IP address). +
+ +Congratulations! You finished the Raspberry Pi setup! + +With the Home Assistant Operating System installed and accessible, you can now continue with onboarding. + +{% include getting-started/next_step.html step="Onboarding" link="/getting-started/onboarding/" %} + {% include installation/container.md %} {% include installation/core.md %} -_We get commissions for purchases made through links in this post._ +## Writing the image with Balena Etcher + +Use this procedure if Raspberry Pi Imager is not supported by your platform. + +1. Insert the SD card into the computer. Note: the contents of the card will be overwritten. +1. Download and start Balena Etcher. You may need to run it with administrator privileges on Windows. +1. Select **Flash from URL**. +![Screenshot of the Etcher software showing flash from URL selected.](/images/installation/etcher1.png) + +1. Copy the correct URL for the Raspberry Pi 3 or 4 (Note: there are 2 different links below!): +{% tabbed_block %} +{% for variant in site.installation.types[page.installation_type].variants %} + +- title: {{ variant.name }} + content: | + + ```text + https://github.com/home-assistant/operating-system/releases/download/{{site.data.version_data.hassos[variant.key]}}/haos_{{ variant.key }}-{{site.data.version_data.hassos[variant.key]}}.img.xz + ``` + +{% endfor %} +{% endtabbed_block %} + +_Select and copy the URL or use the "copy" button that appear when you hover it._ + +1. Paste the URL for the image into Balena Etcher and select **OK**. +![Screenshot of the Etcher software showing the URL bar with a URL pasted in.](/images/installation/etcher2.png) +1. When Balena Etcher has downloaded the image, select **Select target**. +![Screenshot of the Etcher software showing the select target button highlighted.](/images/installation/etcher3.png) +1. Select the SD card you want to use for your installation. +![Screenshot of the Etcher software showing teh targets available.](/images/installation/etcher4.png) +1. Select **Flash!** to start writing the image. +![Screenshot of the Etcher software showing the Flash button highlighted.](/images/installation/etcher5.png) +1. Once Balena Etcher has finished writing the image, you will see a confirmation. +![Screenshot of the Etcher software showing that the installation has completed.](/images/installation/etcher6.png) + + +
+

+ We get commissions for purchases made through links in this post.

+
+