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

You 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:

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

Write the image to your boot medium

  1. Notice: This procedure will write the Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem. It is the recommended installation method for most users.
    [Learn more]
    onto your device.

    • This means you will lose all the data as well as the previously installed operating system.
    • Back up your data before continuing with the next step.
  2. 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.

    If you are using an ODROID-M1S, you need to follow this guide to boot your device into UMS mode.

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

  4. Download the image to your computer.

    • 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/12.2/haos_odroid-n2-12.2.img.xz

Guide: Flashing ODROID-N2 using OTG-USB

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

Guide: Flashing ODROID-N2 using OTG-USB

https://github.com/home-assistant/operating-system/releases/download/12.2/haos_odroid-c2-12.2.img.xz
https://github.com/home-assistant/operating-system/releases/download/12.2/haos_odroid-c4-12.2.img.xz
https://github.com/home-assistant/operating-system/releases/download/12.2/haos_odroid-m1-12.2.img.xz
https://github.com/home-assistant/operating-system/releases/download/12.2/haos_odroid-m1s-12.2.img.xz

Guide: Flashing ODROID-M1S using OTG-USB

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

  1. Paste the URL into your browser to start the download.
  2. Select Flash from file and select the image you just downloaded.
    • Do not use Flash from URL. It does not work on some systems.

Screenshot of the Etcher software showing flash from URL selected. 7. Select target. Screenshot of the Etcher software showing the select target button highlighted. 8. Select the boot medium (eMMC module or SD card) you want to use for your installation. Screenshot of the Etcher software showing the targets available. 9. Select Flash! to start writing the image.

  • If the operation fails, decompress the .xz file and try again. Screenshot of the Etcher software showing the Flash button highlighted.
  • When Balena Etcher has finished writing the image, you will see a confirmation. Screenshot of the Etcher software showing that the installation has completed.

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).

Help us improve Home Assistant

Have you just installed Home Assistant? The Home Assistant team is looking to talk to you to understand how the installation went.

Help now

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

Onboarding

Flashing an ODROID-N2+

Home Assistant can be flashed to an ODROID-N2+ by connecting the device directly to your computer via the USB-OTG connection on the front of the board. The device contains the Petitboot bootloader, which allows the ODROID-N2+ storage to show up as it were a USB drive.

All these instructions work the same for the ODROID-N2 (non-plus version).

What you will need

To flash your eMMC using Petitboot and OTG-USB, you will need the following items:

  • HDMI cable and monitor
  • USB keyboard
  • USB 2.0 to micro-USB cable
  • If your board came in a Home Assistant Blue: No.2 hex key to open the case

Enabling SPI boot mode

To enable the SPI boot mode:

  1. Power off the ODROID-N2+ by unplugging the power cable.

  2. Remove the case.

    Photo of the removed case

  3. Locate the toggle for boot mode and switch it from MMC to SPI.

    Photo of the SPI toggle switch

  4. Connect the ODROID-N2+ directly to your computer via the USB-OTG port located on the front of the board.

  5. Connect a USB keyboard and a monitor (using HDMI) to your ODROID-N2+.

  6. Plug in the power cable to power on the ODROID-N2+.

Enabling USB drive mode

After The ODROID-N2+ is set to SPI boot mode and powered on, it boots into a terminal. To enable the USB drive mode:

  1. Select Exit to shell from the menu.

    Exit to shell

When using the command line, it may return the following message: can't access tty; job control turned off. You can safely ignore this message and proceed with the installation

  1. Use the following command at the console to confirm the storage device node:

    ls /dev/mmc*
    
  2. Set the storage device on the ODROID-N2+ as a mass storage device using the ums command (USB Mass storage mode). This will configure the ODROID-N2+ and OTG to act as a memory card reader:

    ums /dev/mmcblk0
    

Flashing Home Assistant

  1. Connect the ODROID-N2+ to your PC via the micro-USB port at the front of the ODROID-N2+.

  2. When the ODROID-N2 is recognized as a USB connected storage device, you can flash the eMMC with Etcher.

    • Use the latest stable version of Home Assistant OS for the ODROID-N2+ (haos_odroid-n2-12.2.img.xz).
    • In Balena, use Flash from file. Flash from URL does not work on all systems.
  3. When the flash process is complete, disconnect the ODROID-N2+ from your PC.

    • Remove the power cable.
    • Remove the USB and HDMI cables.
    • Make sure to toggle the boot mode switch back to MMC.
  4. Put the ODROID back in its case.

  5. Connect your ODROID-N2+ to your network with an Ethernet cable and plug in power.

  6. If your router supports mDNS, you can reach your installation at http://homeassistant.local:8123.

    • If your network doesn’t support mDNS, you’ll have to use the IP address of your ODROID-N2+ instead of homeassistant.local. For example, http://192.168.0.9:8123.
    • You should be able to find the IP address of your ODROID-N2+ from the admin interface of your router.
  7. Continue with onboarding.

Flashing an ODROID-M1S

Home Assistant can be flashed to an ODROID-M1S by connecting the device directly to your computer via the USB-OTG connection on the front of the board. Unlike other ODROID boards, the M1S does not have a socket for an optional eMMC module. It also does not have a separate flash chip that holds a dedicated bootloader. Instead, the M1S has a build-in 64GB eMMC soldered directly on the board that holds a bootloader by default. This guide will show you how to install the Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem. It is the recommended installation method for most users.
[Learn more]
to the built-in eMMC.

Warning: Installing Home Assistant OS replaces the firmware and SPL on the eMMC with the mainline version provided by the Home Assistant OS. As a result, it is not possible to use the SD card with the EMMC2UMS image anymore, because the mainline SPL is not compatible with U-Boot in the EMMC2UMS image at this time (February 2024). This does not pose any problem for standard use, just makes it more complicated in case you want to return to the Hardkernel-provided OS (see HK Recovery).

What you will need

To flash your eMMC using USB-OTG, you will need the following items:

  • A small SD card
  • Another computer
  • USB 2.0 to micro-USB cable
  • the special Hardkernel eMMC-to-USB-mass-storage image

Boot into mass-storage mode

(These steps are identical to the official Hardkernel wiki page.)

  1. Download ODROID-M1S_EMMC2UMS.img.
  2. Use balena Etcher or another tool to flash the UMS utility onto an SD card.
    • Use Flash from file. Flash from URL does not work on all systems. (balena Etcher will complain that something went wrong during flashing. You can ignore this message)
  3. Plug-in that SD card to your ODROID-M1S and boot it.

Flashing Home Assistant M1S

  1. Download the latest stable version of Home Assistant OS for the ODROID-M1S.
  2. Apart from the HAOS image to flash (M1S instead of N2+ version), you can follow the N2+ step-by-step flashing guide HERE.

HK Recovery

If you want to restore your M1S back into Hardkernel’s initial state, you will have to restore the HK’s bootloader. A reliable way of reflashing the eMMC with an operating system of your choice is to use Home Assistant OS to flash the EMMC2UMS image which turns the ODROID-M1S into USB Mass Storage device. Once you have flashed the EMMC2UMS image, you can flash any OS again. You will need a micro USB cable to connect ODROID-M1S to PC.

Note: This commands will render your current Home Assistant OS installation unbootable!

Use the local terminal (HDMI/keyboard) to access the system console. On the Home Assistant CLI (command line), enter login to enter the root shell and use curl to download an image and dd it to the eMMC block device:

curl https://dn.odroid.com/RK3566/ODROID-M1S/Installer/ODROID-M1S_EMMC2UMS.img | dd of=/dev/mmcblk0

This way, the device will start in the UMS mode on the next boot with the SD card removed. Follow the Install over USB from PC to install a different operating system.

Install Home Assistant Container

These below instructions are for an installation of Home Assistant ContainerHome Assistant Container is a standalone container-based installation of Home Assistant Core. Any OCI compatible runtime can be used, but the documentation focus is on Docker.
[Learn more]
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. Make sure that you keep the :/config part.

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

  • D-Bus is optional but required if you plan to use the Bluetooth integration.

    docker run -d \
      --name homeassistant \
      --privileged \
      --restart=unless-stopped \
      -e TZ=MY_TIME_ZONE \
      -v /PATH_TO_YOUR_CONFIG:/config \
      -v /run/dbus:/run/dbus:ro \
      --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 \
      -v /run/dbus:/run/dbus:ro \
      --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
            - /run/dbus:/run/dbus: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.12 (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 libtiff6 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) homeassistant@raspberrypi:/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==2024.4.3
    

    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.