Setup AquaPi - TheRealFalseReality/aquapi GitHub Wiki

AquaPi Hardware Setup Guide

Welcome to the AquaPi setup guide! Follow these steps to connect your AquaPi hardware and get started with Home Assistant or the built-in Web Server.


Step 1: Connect the Sensors

Note

All sensors and their respective connectors are color-coded for ease of installation:

  • Green: Dallas Temperature Probe(s) (support for 2+ probes with an additional Y-cable).
  • Blue/Yellow: Optical Sensors (connected via the supplied Y-cable).
  • Red: All I2C sensors, including EZO sensors (connect multiple sensors using additional Y-cables).
  • White: Water Leak Sensor & Optional sensors, such as extra optical sensors or DAC pins (reserved for future use).

Warning

The AquaPi will not boot if the Binary 2 sensor is ON. If this occurs, physically remove the sensor, boot the AquaPi, then reconnect the sensor. This applies only when adding your own custom sensors.


Step 2: Set Up Home Assistant

  1. Install and Power On Home Assistant:

    • Download and install the latest version of Home Assistant.
    • Connect Home Assistant to your network using an Ethernet cable and power it on.
  2. Access Home Assistant in Your Browser:

    • Open your preferred web browser.
    • Navigate to:
      http://homeassistant.local:8123
      
  3. Complete Home Assistant Onboarding:

    username onboarding_devices

Step 3: Connect AquaPi to WiFi

  1. Power on the AquaPi:

    • Plug in the AquaPi. Use your mobile phone to connect to the WiFi network named aquapi-XXXXXX (where XXXXXX matches your device name).
  2. Join Your Home WiFi Network:

    • Select your home WiFi network, enter the WiFi password, and connect.
Screenshot_20230812-234153EDIT Screenshot_20230812-234744EDIT
  1. Discover AquaPi in Home Assistant:
    • In Home Assistant, you should see a New Device Discovered notification. Alternatively, go to Settings > Devices & Services to find your device.
    • Click Configure for the device named AquaPi XXXXXX (matching the WiFi name) and follow the prompts to add it to Home Assistant.
    • Once connected, the Blue LED on AquaPi will stop flashing.
Screenshot_20230813-141640 AScreenshot_20230813SD144346

Step 4: Install ESPHome Add-On

  1. Install ESPHome in Home Assistant:
    • Navigate to the Add-On Store section in Home Assistant.
    • Find and install the ESPHome Add-On.
    • Once installed, click Open Web UI to launch the ESPHome dashboard.
Screenshot_20230813-144240 Screenshot_20230813-144513
  1. Adopt AquaPi in ESPHome:
    • In the ESPHome dashboard, locate your AquaPi device. It should appear with a green Adopt button.
    • Click Adopt, follow the prompts to complete setup.
    • Enter your WiFi credentials when prompted, then select Install > Wirelessly to update the firmware.
Screenshot_20230813-144723 Screenshot_20230813-153752

Updating the AquaPi

Option 1: Using ESPHome

  • Open the ESPHome dashboard, click on the 3-dots menu for your AquaPi device, and select Install.
  • This will download and install the latest firmware while preserving any custom configurations made to the YAML configuration file.

Option 2: Using Home Assistant

  • Update directly from the Home Assistant UI via the Update Firmware button on the AquaPi integration page. Home Assistant will notify you when a new update is available.

Important

Updating via Home Assistant resets the device to factory defaults. You may need to re-provision your Wi-Fi and reconfigure the device after the update.

Get the Latest Release Here

Screenshot_20230813-153815 Screenshot_20230813-153825

Web Server Access

As an alternative to Home Assistant, you can access the AquaPi Web Server:

  1. After connecting AquaPi to WiFi, open a browser and navigate to:
    http://<hostname>.local/
    
    Replace <hostname> with the name of your AquaPi device (e.g., aquapi-6734b0.local/).

Let me know if you’d like further edits or additions! This updated version improves consistency, clarifies key steps, and maintains a user-friendly tone while integrating your previously provided content and screenshots efficiently.

⚠️ **GitHub.com Fallback** ⚠️