Skip to article frontmatterSkip to article content
Getting started

Installing Spook in Home Assistant

Don't worry, we'll go through it step-by-step.

Time to get Spook πŸ‘» settled and installed in your Home Assistant instance.

Getting Spook up and running should not be too hard when you follow this guide. If you run into issues during the installation, please check the Support page on where to go for help.

1RequirementsΒΆ

Spook needs a few things to work properly, so let’s go over them first.

  1. Read, understand, and accept the license of Spook.

  2. A working Home Assistant instance running version 2024.2.0 or newer.

  3. You have the Home Assistant Community Store (HACS) installed.

    I don’t have HACS installed. How do I do that? πŸ‘ˆ

    If you don’t have HACS installed yet, please follow the official installation guide.

If you have met these requirements, you are ready to install Spook. πŸŽ‰

2InstallationΒΆ

Time to download and install Spook πŸ‘» onto your Home Assistant instance.

HACS can be configured to run in two different modes: standard and experimental. Spook is available in both modes, but the installation process differs slightly. If you are using the experimental mode, be sure to select the HACS with experimental mode enabled tab below.

Standard HACS
HACS with experimental mode enabled
  1. From the Home Assistant sidebar, select HACS. This will open the Home Assistant Community Store dashboard.

  2. Select Integrations.

    Screenshot showing the HACS dashboard.
  3. Select the Explore & download repositories button in the bottom right corner.

  4. Select the search bar in the dialog shown and search for Spook.

  5. Spook should now appear in the search results. Select it.

    Screenshot showing the HACS dashboard searching for Spook.
  6. On the Spook page in HACS, select the Download button in the bottom right corner.

    Screenshot showing the Spook page in the HACS store.
  7. In the download dialog shown, select Download to download the Spook integration to your Home Assistant instance.

    Screenshot showing the download dialog in HACS.
  8. After the download process has been completed, you need to restart Home Assistant in order for Home Assistant to see the new Spook integration.

    1. Select Settings from the sidebar, and then select System.
    2. In the top right corner select the power button.
    3. Select Restart Home Assistant in the dialog that appears.
    Screenshot showing the Home Assistant restart dialog.

After Home Assistant has restarted, you are ready to activate the Spook integration.

3Activating the Spook integrationΒΆ

Now that Spook is installed, it is time to set up the integration in Home Assistant. This works exactly the as setting up any other integration in Home Assistant.

  1. From the Home Assistant sidebar, select Settings and next select Devices & Services.

  2. On the Devices & Services page, in the bottom right corner, select the + Add integration button.

    Screenshot showing the device & services page in Home Assistant.
  3. Select the search bar at the top of the dialog shown and search for Spook.

  4. Spook should now appear in the search results. Select it.

    Screenshot showing showing the integration search dialog in Home Assistant.
  5. Confirm you have read, understood, and accepted the license. Then select Submit.

    Screenshot showing the Spook add integration dialog in Home Assistant.
  6. It now takes a few seconds for the Spook integration to be set up, after which a success dialog will appear. Select Finish to close the dialog.

πŸŽ‰ You have successfully completed setting up Spook πŸ‘» in Home Assistant. πŸŽ‰