Installation Guide for Home Assistant

Installing Home Assistant Operating System

  1. Download the Image: Visit the Home Assistant website and download the appropriate image for your system.

-Minimum  virtual system requirements:

2 GB RAM | 32 GB Storage | 2vCPU

  1. Create a Virtual Machine:
    • Create a new virtual machine.
    • Select type Linux and version Linux 2.6 / 3.x / 4.x (64-bit).
    • Under Hardware, select the amount of memory and number of CPUs. Then, select Enable EFI. (Make sure EFI is enabled. If EFI is not enabled, HAOS won’t boot.)
    • Under Hard Disk, select Use an existing virtual hard disk file, select the unzipped VDI file from above.
    • Then go to Network > Adapter 1. Choose Bridged Adapter and choose your network adapter.
  • VMwareWorkstation
    1. Start VMware Workstation and select Create a New Virtual Machine. 
    2. Select “I will install the operating system later”, then select Linux > Other Linux 5.x kernel 64-bit.
    3. Give the VM a name, home-assistant, and define an easy to reach storage location, such as C:\home-assistant.
    4. Specify the disk size and select Store virtual disk as a single file.
    5. Select Customize Hardware. Define the amount of memory and the number of cores the VM is allowed to use.
    6. Remove the New CD/DVD entry. It will not be used.
    7. Connect an Ethernet cable and make sure it is connected to your network.
    8. Under Network adapter, select Bridged: Connected directly to the physical network.
    9. Make sure the Replicate physical network connection state is not selected.
    10. Select Configure Adapters. Make sure all virtual adapters and Bluetooth devices are deselected.
    11. Select your host network adapter. Most likely, this is one of the first 2 checkboxes in the list: Select the one for Ethernet. The exact names of these adapters depend on your hardware.
    12. At the end of the wizard, select Finish.
  • Hyper-V:
    1. Create a new virtual machine.
    2. Select Generation 2.
    3. Select Connection > Your Virtual Switch that is bridged.
    4. Select Use an existing virtual hard disk and select the VHDX file from above.
    5. After creation, go to Settings > Security and deselect Enable Secure Boot
  • Start the Virtual Machine: Boot the virtual machine and follow the on-screen instructions to complete the installation.
  • Use Home Assistant: You will be able to reach Home Assistant on 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 ’s IP address).
    1. Open the Home Assistant version installed above: Once you have opened Home Assistant, log in using your credentials. 
    2. Navigate to the ‘settings’ in the bottom left. Once you have entered settings click on System>Backups
    3. Now you are in the Backups tab: Click on the 3 dots in the top right, and select upload backup
    4. Upload the ‘.tar’ file downloaded from our website.
    5. Now you are all set! 

    Installing Home Assistant Core

    1. Enable WSL (Windows Subsystem for Linux):

    Open PowerShell as Administrator and run:
    dism.exe /online /enable-feature /featurename:Microsoft-Windows-Subsystem-Linux /all /norestart

    dism.exe /online /enable-feature /featurename:VirtualMachinePlatform /all /norestart

    1. Install a Linux Distribution:
      • Visit the Microsoft Store and install a Linux distribution like Ubuntu.
    2. Set Up Home Assistant Core:

    Open your Linux distribution and update the package list:
    sudo apt-get update

    sudo apt-get upgrade

    Install dependencies:
    sudo apt-get install python3 python3-venv python3-pip

    Create a virtual environment and install Home Assistant:
    python3 -m venv homeassistant

    cd homeassistant

    source bin/activate

    pip install homeassistant

    1. Run Home Assistant:

    Start Home Assistant with the following command:
    hass

    Overview

    The EffortlessHome addon and integration make it easy to connect your smart home devices to Home Assistant, providing local control, privacy, and advanced automation features. Follow the steps below to get started.

    Step 1: Add the EffortlessHome Repository

    1. Open your Home Assistant web interface.
    2. Go to Settings > Add-ons > Add-on Store.
    3. Click the three dots in the top right and select Repositories.
    4. Paste the following URL and click Add:
      https://github.com/effortlesshome/

    Step 2: Install the EffortlessHome Addon

    1. Find EffortlessHome in the Add-on Store list.
    2. Click on it, then click Install.
    3. After installation, click Start to launch the addon.
    4. Optionally, enable Start on boot and Watchdog for reliability.

    Step 3: Set Up the EffortlessHome Integration

    1. Go to Settings > Devices & Services.
    2. Click Add Integration and search for EffortlessHome.
    3. Follow the prompts to complete the setup and connect your devices.
    ## 🚀 Getting Started ### 1. Account Setup Before installing the integration, you need an EffortlessHome account. - **Visit**: [my.effortlesshome.co](https://my.effortlesshome.co) to sign up and configure your system. ### 2. Installation #### Via HACS (Recommended) 1. Open **HACS** in Home Assistant. 2. Search for `EffortlessHome`. 3. Click **Download** and restart Home Assistant. #### Manual Installation 1. Copy the `custom_components/effortlesshome` directory to your Home Assistant `custom_components/` folder. 2. Restart Home Assistant. ### 3. Configuration 1. Navigate to **Settings > Devices & Services**. 2. Click **Add Integration** and search for **EffortlessHome**. 3. Sign in with your credentials or enter your IDs manually. --- ## 🛠️ Requirements - Home Assistant 2024.1 or later. - `recorder` component must be enabled. - Active internet connection for AI features (cloud polling). --- ## 🤝 Community & Support - **Report Issues**: [GitHub Issues](https://github.com/effortlesshome/effortlesshome/issues) - **Documentation**: [Official Docs](https://github.com/effortlesshome/) - **Website**: [effortlesshome.co](https://effortlesshome.co)
    # effortlesshome Home Assistant Add-ons Home Assistant add-ons repository for effortlesshome. ## Installation Add this repository to your Home Assistant instance: 1. Navigate to **Settings** → **Add-ons** → **Add-on Store** 2. Click the **⋮** (three dots) in the top right 3. Select **Repositories** 4. Add this URL: `https://github.com/EffortlessHome/effortlesshome_addon` 5. Click **Add** ## Available Add-ons ### EffortlessHome Cloud Connect your Home Assistant to effortlesshome Cloud services with: - **Cloudflare Tunnel** - Secure remote access - **Matter Hub Integration** - Matter protocol bridge for smart home devices - **Unified Web Dashboard** - Single interface for all features #### Features - **Main Dashboard** (accessible at `/`) - Monitor and manage effortlesshome services - **Matter Hub UI** (accessible at `/matter/`) - Configure and manage Matter devices - Single port (8080) for both interfaces - Automatic authentication using effortlesshome credentials - Persistent storage for Matter devices See [MATTER_INTEGRATION.md](MATTER_INTEGRATION.md) for technical details about the Matter integration. ## Support For support and questions, visit [effortlesshome](https://effortlesshome.co)

    Troubleshooting & Support

    Next Steps

    Once installed, explore the benefits and use cases of EffortlessHome to get the most out of your smart home.