Home Assistant Home Assistant

ODROID

Install Home Assistant Operating System

Follow this guide if you want to get started with Home Assistant easily or if you have little to no Linux experience.

Suggested hardware

We will need a few things to get started with installing Home Assistant. The links below lead to Ameridroid. If you’re not in the US, you should be able to find these items in web stores in your country.

To get started, we suggest the ODROID N2+, the board that powers our Home Assistant Blue, or the ODROID M1.

If unavailable, we also recommend the ODROID C4.

Home Assistant bundles (US market):

The bundles come with Home Assistant pre-installed.

Variants without pre-installed Home Assistant:

Write the image to your boot medium

  1. Attach the Home Assistant boot medium (eMMC module or SD card) to your computer.

    If you are using ODROID M1, note that booting from NVMe is not supported. If you want to boot from eMMC, update the firmware before installing the image.

    If you are using a Home Assistant Blue or ODROID N2+, you can attach your device directly.

  2. Download and start Balena Etcher. You may need to run it with administrator privileges on Windows.

  3. Select Flash from URL. Screenshot of the Etcher software showing flash from URL selected.

  4. Copy the URL for the image. If there are multiple links below, make sure to select the correct link for your version of ODROID:

https://github.com/home-assistant/operating-system/releases/download/10.2/haos_odroid-n2-10.2.img.xz

Guide: Flashing Odroid-N2 using OTG-USB

https://github.com/home-assistant/operating-system/releases/download/10.2/haos_odroid-n2-10.2.img.xz

Guide: Flashing Odroid-N2 using OTG-USB

https://github.com/home-assistant/operating-system/releases/download/10.2/haos_odroid-c2-10.2.img.xz

https://github.com/home-assistant/operating-system/releases/download/10.2/haos_odroid-c4-10.2.img.xz

https://github.com/home-assistant/operating-system/releases/download/10.2/haos_odroid-m1-10.2.img.xz

Select and copy the URL or use the “copy” button that appear when you hover it.

  1. Paste the URL for the ODROID image into Balena Etcher and select OK. Screenshot of the Etcher software showing the URL bar with a URL pasted in.
  2. When Balena Etcher has downloaded the image, click Select target. Screenshot of the Etcher software showing the select target button highlighted.
  3. Select the boot medium (eMMC module or SD card) you want to use for your installation. Screenshot of the Etcher software showing teh targets available.
  4. Select Flash! to start writing the image. Screenshot of the Etcher software showing the Flash button highlighted.
  5. When Balena Etcher has finished writing the image, you will see a confirmation. Screenshot of the Etcher software showing that the installation has completed.
    • If you are having issues with Balena Etcher, try version 1.10.

Start up your ODROID

  1. Insert the boot medium (eMMC module or SD card) you just created.

  2. Plug in an Ethernet cable that is connected to the network and power the system on.

  3. 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 ODROID’s IP address).

With the Home Assistant Operating System installed and accessible, you can continue with onboarding.

Onboarding

Install Home Assistant Container

These below instructions are for an installation of Home Assistant Container running in your own container environment, which you manage yourself. Any OCI compatible runtime can be used, however this guide will focus on installing it with Docker.

Prerequisites

This guide assumes that you already have an operating system setup and a container runtime installed (like Docker).

If you are using Docker then you need to be on at least version 19.03.9, ideally an even higher version, and libseccomp 2.4.2 or newer.

Platform installation

Installation with Docker is straightforward. Adjust the following command so that:

  • /PATH_TO_YOUR_CONFIG points at the folder where you want to store your configuration and run it.

  • MY_TIME_ZONE is a tz database name, like TZ=America/Los_Angeles.

    docker run -d \
  --name homeassistant \
  --privileged \
  --restart=unless-stopped \
  -e TZ=MY_TIME_ZONE \
  -v /PATH_TO_YOUR_CONFIG:/config \
  --network=host \
  ghcr.io/home-assistant/home-assistant:stable

    # if this returns "Image is up to date" then you can stop here
docker pull ghcr.io/home-assistant/home-assistant:stable

    # stop the running container
docker stop homeassistant

    # remove it from Docker's list of containers
docker rm homeassistant

    # finally, start a new one
docker run -d \
  --name homeassistant \
  --restart=unless-stopped \
  --privileged \
  -e TZ=MY_TIME_ZONE \
  -v /PATH_TO_YOUR_CONFIG:/config \
  --network=host \
  ghcr.io/home-assistant/home-assistant:stable

    Once the Home Assistant Container is running Home Assistant should be accessible using http://<host>:8123 (replace with the hostname or IP of the system). You can continue with onboarding.

    Onboarding

    Restart Home Assistant

    If you change the configuration, you have to restart the server. To do that you have 3 options.

    1. In your Home Assistant UI, go to the Settings > System and click the Restart button.
    2. You can go to the Developer Tools > Services, select the service homeassistant.restart and select Call Service.
    3. Restart it from a terminal.
    docker restart homeassistant

    docker compose restart

    Docker compose

    docker compose should already be installed on your system. If not, you can manually install it.

    As the Docker command becomes more complex, switching to docker compose can be preferable and support automatically restarting on failure or system restart. Create a compose.yml file:

      version: '3'
  services:
    homeassistant:
      container_name: homeassistant
      image: "ghcr.io/home-assistant/home-assistant:stable"
      volumes:
        - /PATH_TO_YOUR_CONFIG:/config
        - /etc/localtime:/etc/localtime:ro
      restart: unless-stopped
      privileged: true
      network_mode: host

    Start it by running:

    docker compose up -d

    Once the Home Assistant Container is running, Home Assistant should be accessible using http://<host>:8123 (replace with the hostname or IP of the system). You can continue with onboarding.

    Onboarding

    Exposing devices

    In order to use Zigbee or other integrations that require access to devices, you need to map the appropriate device into the container. Ensure the user that is running the container has the correct privileges to access the /dev/tty* file, then add the device mapping to your container instructions:

    docker run ... --device /dev/ttyUSB0:/dev/ttyUSB0 ...

    version: '3'
services:
  homeassistant:
    ...
    devices:
      - /dev/ttyUSB0:/dev/ttyUSB0

    Optimizations

    The Home Assistant Container is using an alternative memory allocation library jemalloc for better memory management and Python runtime speedup.

    As jemalloc can cause issues on certain hardware, it can be disabled by passing the environment variable DISABLE_JEMALLOC with any value, for example:

    docker run ... -e "DISABLE_JEMALLOC=true" ...

    version: '3'
services:
  homeassistant:
  ...
  environment:
    - DISABLE_JEMALLOC: true

    The error message <jemalloc>: Unsupported system page size is one known indicator.

    Install Home Assistant Core

    This is an advanced installation process, and some steps might differ on your system. Considering the nature of this installation type, we assume you can handle subtle differences between this document and the system configuration you are using. When in doubt, please consider one of the other installation methods, as they might be a better fit instead.

    Prerequisites

    This guide assumes that you already have an operating system setup and have installed Python 3.10 (including the package python3-dev) or newer.

    Install dependencies

    Before you start, make sure your system is fully updated, all packages in this guide are installed with apt, if your OS does not have that, look for alternatives.

    sudo apt-get update
sudo apt-get upgrade -y

    Install the dependencies:

    sudo apt-get install -y python3 python3-dev python3-venv python3-pip bluez libffi-dev libssl-dev libjpeg-dev zlib1g-dev autoconf build-essential libopenjp2-7 libtiff5 libturbojpeg0-dev tzdata ffmpeg liblapack3 liblapack-dev libatlas-base-dev

    The above-listed dependencies might differ or missing, depending on your system or personal use of Home Assistant.

    Create an account

    Add an account for Home Assistant Core called homeassistant. Since this account is only for running Home Assistant Core the extra arguments of -rm is added to create a system account and create a home directory. The arguments -G dialout,gpio,i2c adds the user to the dialout, gpio and the i2c group. The first is required for using Z-Wave and Zigbee controllers, while the second is required to communicate with GPIO.

    sudo useradd -rm homeassistant -G dialout,gpio,i2c

    Create the virtual environment

    First we will create a directory for the installation of Home Assistant Core and change the owner to the homeassistant account.

    sudo mkdir /srv/homeassistant
sudo chown homeassistant:homeassistant /srv/homeassistant

    Next up is to create and change to a virtual environment for Home Assistant Core. This will be done as the homeassistant account.

    sudo -u homeassistant -H -s
cd /srv/homeassistant
python3 -m venv .
source bin/activate

    Once you have activated the virtual environment (notice the prompt change to (homeassistant) [email protected]:/srv/homeassistant $) you will need to run the following command to install a required Python package.

    python3 -m pip install wheel

    Once you have installed the required Python package, it is now time to install Home Assistant Core!

    pip3 install homeassistant==2023.5.4

    Start Home Assistant Core for the first time. This will complete the installation for you, automatically creating the .homeassistant configuration directory in the /home/homeassistant directory, and installing any basic dependencies.

    hass

    You can now reach your installation via the web interface on http://homeassistant.local:8123.

    If this address doesn’t work you may also try http://localhost:8123 or http://X.X.X.X:8123 (replace X.X.X.X with your machines’ IP address).

    When you run the hass command for the first time, it will download, install and cache the necessary libraries/dependencies. This procedure may take anywhere between 5 to 10 minutes. During that time, you may get a site cannot be reached error when accessing the web interface. This will only happen the first time. Subsequent restarts will be much faster.

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