Gathering the required items

  • Home Assistant Yellow
  • Ethernet cable

Additionally, make sure you have the following items which are not part of the Kit

  • Raspberry Pi Compute Module 5 (CM5)
  • USB-C cable
  • If you are using PoE, make sure your router or switch provides PoE on that port
  • Optional: Power supply (12 V / 2 A, if PoE is not used)
  • Flat nose pliers

Preparation steps:

  • Make sure you installed Home Assistant Operating System version 14 or later.
  • Make sure you have created a backup.
    • Before creating a backup, make sure your CM5 eMMC has enough storage capacity.
    • Check how much disk space you've used under Settings > System > Storage.
    • If this is larger than the eMMC, you need to reduce the size of your instance.

Opening the case

Step 1

Protecting from ESD

Grounding protects the components from the static electricity that can be naturally present (electrostatic discharge, ESD).

  • Always: Touch the working surface before touching electronics.
  • Ideally: Use ESD protective equipment, such as ESD table mats and grounding cords.

Step 2

Removing the case - bottom part
  • Remove the 4 screws on the bottom of the Home Assistant Yellow Kit.
  • Keep the thumb screws close by; you will need them again later.

Step 3

Removing the case - top part
  • Make sure the interfaces are facing towards your left.
  • Flip the case over.
  • Slightly lift off the enclosure on your left.
  • Slide the enclosure off towards your right.

Removing the Raspberry Pi Compute Module

Step 1

Removing the heat sink
  • Use the pliers and squeeze the front of the pin so that it fits through the hole.
  • Repeat the procedure for the other pin.

Step 2

Removing the Raspberry Pi Compute Module
  • Info: The image shows a Raspberry Pi Compute Module 4. The steps are the same for the Compute Module 5.
  • Ideally, the module should be pulled up vertically. But this is hard to do.
  • Pull up the module from one side, tilting as little as possible. Tilting can damage the connector.
  • This requires quite a bit of force. If it does not work, pull harder.
  • Do not use a screw driver as a lever. It might damage the board.

Seating the Raspberry Pi Compute Module 5

Step 1

Align the Compute Module
  1. Place the board in front of you, the red and blue buttons facing to the right.
  2. Orient the CM5: The Raspberri Pi text needs to be on the right hand side.
  3. Carefully place the CM5 without force.
    • The CM5 should fall into place slightly when correctly aligned.

Step 2

Installing the CM5
  1. Press the Compute Module 5 onto the board-to-board connectors until it clicks into place.
    • Make sure you press on both sides (the two long edges).
    • This requires quite a bit of force. If you don't hear a loud click, it is most likely not fully seated.
  2. It has been reported that on some boards, there is no click sound when pressing the module onto the board. It can still be seated correctly.
  3. Do a visual check to make sure the module is installed correctly: it needs to run parallel to the Home Assistant Yellow board. You can also pull a bit on the sides to make sure it is not loose.
  4. Notice: Don't use screws to fix the module in place. The screws can damage the CM5 module.

Step 3

Placing the heat sink
  • Push the 2 plastic push pins into the dedicated hole on the heat sink.
    • Start by first aligning the right plastic push pins into the dedicated hole on the carrier board.
    • Then, place the heat sink onto the module.

Step 4

Securing the heat sink
  1. Take the entire board off your workplace and push the pins firmly through the carrier board.
  2. Ensure that the module is still fully seated after securing the heat sink.

Running rpiboot

Step 1

Install rpiboot on your computer.
  • rpiboot is a command line utility for booting a Raspberry Pi in USB device mode. This is needed because the CM5 cannot boot from the USB 2.0 ports of the Yellow.
  • Install rpiboot on your PC.

Step 2

Connect the Yellow to your PC
  1. On the Yellow board, make sure the JP1 jumper is set to USB.
    • It is there by default, but it is worth to double-check.
  2. Plug-in a USB-C cable to Home Assistant Yellow and connect it to your PC.
    • Make sure the cable supports USB 2.0 data.

Step 3

Press recovery button and power up
  1. On the Yellow board, press and hold the recovery button.
    • Older Home Assistant Yellow versions: Bridge JP2 (USB-C Rcvry).
  2. Power up the board.
    • Only the red LED should be on at this point (solid, not blinking).
  3. Release the recovery push button.
    • Older Home Assistant Yellow versions: Un-bridge JP2.

Step 4

Run rpiboot
  • On your PC, run rpiboot and let it run through.
    • If you are using Windows, it might ask you if you want to reformat the disk. Select Cancel each time.
    • If you are running an Apple Silicon mac, before running rpiboot, make sure you open the terminal using the “Rosetta” compatibility mode.
    • If you are using Linux or MacOS, use sudo ./rpiboot -d mass-storage-gadget64 to run the tool.
  • After a few seconds, the yellow LED on the Yellow board should start blinking.
  • Afterwards, only the green LED should be on.
  • The module is now ready to have the Home Assistant Operating System installed on it (next steps).

Installing Home Assistant Software on CM5

Step 1

Installing the Raspberry Pi Imager
  • Install the Raspberry Pi Imager on your computer as described under https://www.raspberrypi.com/software/
  • If your platform doesn't support the Raspberry Pi Imager, you can use another imager (e.g. balenaEtcher) and flash the Home Assistant OS Installer for Yellow directly from GitHub releases.

Step 2

Open Raspberry Pi Imager
  • Open Raspberry Pi Imager.
  • Under Raspberry Pi Device, select Raspberry Pi 5.

Step 3

Choosing the operating system
  • Select Choose OS
  • Choose Other specific-purpose OS.
  • Choose Home assistants and home automation.
  • Choose Home Assistant.
  • Choose Home Assistant OS x.y (Yellow).

Step 4

Choosing storage
  • Select Choose storage and from the dropdown menu, select your Raspberry Pi module.

Step 5

Writing the installer onto the drive
  1. Select the Next button to start the process.
  2. Wait for the Home Assistant OS Installer to be written to the internal eMMC storage on your module.
  3. Follow the wizard.
  4. When the steps are complete, close the rpi-installer.

Step 6

Unplug and set to UART
  1. Unplug the USB cable.
  2. Unplug the power cable.
  3. Set the JP1 jumper to UART.

Reassembling your Home Assistant Yellow

Step 1

Preparation
  • Place the translucent bottom part of the case onto the table.
  • Make sure the two round notches form a line pointing towards the top right corner.

Step 2

Reassembling - bottom part
  • Place the board onto the bottom part of the case.
  • Make sure the USB connectors are facing upwards, away from you.

Step 3

Reassembling - top part
  • Turn the enclosure upside down.
  • Then, slide the push buttons into the openings of the case.

Step 4

Mounting the case
  • Insert the 4 thumb screws.
  • Do not over-tighten the screws.

Powering up and getting started

Step 1

Power up and watch the LEDs
  • Connect Ethernet and power.
  • Start up may take a while. Once the yellow LED blinks in a heartbeat pattern, the system is up and running.

Step 2

Getting started with Home Assistant
  1. Open Home Assistant:
  2. On the onboarding screen, select Restore from backup.
  3. For more information, refer to the section on restoring from backup.