Install Instructions

From Install Page

Use the GitHub pages, scroll down to Install then click the blue Connect button to install software onto your AquaPi device via USB (Desktop Chrome browser only).

From Releases

Use Releases for a .bin and install via ESPHome Web.

From Source

1. Copy the contents of aquapi_config.yaml into ESPHome instance after adding an esp32 device named AquaPi (recommended).
2. Remove the following lines:

If you do not want the last 5 digits of the MAC Address to be appended:

name_add_mac_suffix: true

[!TIP] Using source code, you can also customize anything and add your own sensors! Make it your own!

YAML Method

Copy the following code. Replace your exising yaml code for your ESP32 device, while keeping your wifi secrets and encrytion key it added when creating the deivce

substitutions:
  name: aquapi
  friendly_name: AquaPi
packages:
  TheRealFalseReality.aquapi: github://TheRealFalseReality/aquapi/aquapi_config.yaml@main
esphome:
  name: ${name}
  name_add_mac_suffix: false # or true
  friendly_name: ${friendly_name}
  
api:
  encryption:
    key: <your encryption key>

wifi:
  ssid: !secret wifi_ssid
  password: !secret wifi_password