generated from esphome/esphome-project-template
-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
18019a6
commit 79c868b
Showing
1 changed file
with
35 additions
and
50 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,97 +1,82 @@ | ||
| # AquaPi for ESPHome | ||
|
|
||
| The Aquarium meets the Smart Home! | ||
| **[Setup Guide](https://github.com/TheRealFalseReality/aquapi/wiki/Setup-AquaPi)** | ||
|
|
||
| Monitor your Aquarium's Temperature and Water Level. With EZO Circuit Boards and Probe upgrades, you can also monitor your pH, Salinity, Dissolved Oxygen and other EZO circuits and probes. | ||
| Powered by an [esp32](https://esphome.io/) and Controlled by [HomeAssistant](https://www.home-assistant.io/installation/). You can set alerts for anything, make automations for auto-top-off (see Blueprints), and make beautiful graphs of your aquarium's data (see screenshot). | ||
|
|
||
| Use the 'View on GitHub' link above for more information and make suggestions. | ||
|
|
||
| **[Buy Now!](https://www.capitalcityaquatics.com/store/p/aquapi)** | ||
| |  |  | | ||
| | ------------- | ------------- | | ||
|
|
||
| ## Installation | ||
| **You can typically skip this as AquaPi comes pre-installed!** | ||
| Use the button below to install the pre-built firmware directly to your device via USB from the browser. | ||
|
|
||
| <esp-web-install-button manifest="./manifest.json"></esp-web-install-button> | ||
|
|
||
| <script type="module" src="https://unpkg.com/[email protected]/dist/web/install-button.js?module"></script> | ||
|
|
||
| ## Setup AquaPi | ||
| Follow link below for guide: | ||
| <a href="https://github.com/TheRealFalseReality/aquapi/wiki/Setup-AquaPi" target="_blank"><b>Setup Guide</b></a> | ||
|
|
||
| ## Home Assistant & AquaPi | ||
| Basic UI | ||
| |  |  | | ||
| | ------------- | ------------- | | ||
|  | ||
|
|
||
| ### [Blueprints](https://github.com/TheRealFalseReality/aquapi/wiki/Blueprints) | ||
| There are scripts and automations I created to control other devices within Home Assistant. Click the link above to view them all! | ||
|
|
||
| ### Home Assistand Dashboard & Card Examples | ||
| If you want to try some of the Dashboard or Cards I use, follow the link below. You may need addtional integrations or custom cards for some of them! | ||
| **[Example HomeAssistant Cards & Templates](https://github.com/TheRealFalseReality/aquapi/tree/main/Example%20HomeAssistant%20Cards%20%26%20Templates)** | ||
| <a href="https://github.com/TheRealFalseReality/aquapi/tree/main/Example%20HomeAssistant%20Cards%20%26%20Templates" target="_blank"><b>Example HomeAssistant Cards & Templates</b></a> | ||
|
|
||
| ## Hardware Used | ||
| **ESP32 devkit** | ||
| **ESP32 devkit** | ||
| **HomeAssistant** using a Raspberry Pi 3 or above. The more RAM, the better. | ||
| **Prerequisite!!** A Raspberry Pi (or something similar) running HomeAssistant to communicate and interact with the ESP32 via `homeassistant.local:8123`. | ||
| Get [Raspberry Pi Imager](https://www.raspberrypi.com/software/) | ||
|
|
||
| ### Probes | ||
| **Probes**: | ||
| ***Temperature*** | ||
| - DS18B20 Waterproof Thermistor | ||
|
|
||
| ***Water Level*** | ||
| - Food Grade Optical Infrared Water Liquid Level Sensor | ||
|
|
||
| ***pH:*** Atlas Scientific pH Kit | ||
| ***pH:*** [Atlas Scientific pH Kit](https://files.atlas-scientific.com/pH_EZO_Datasheet.pdf) | ||
| - EZO™ pH Circuit | ||
| - Double junction silver / silver chloride Lab Grade pH Probe | ||
| - Electrically Isolated EZO™ Carrier Board | ||
|
|
||
| ***Salinity:*** Atlas Scientific Conductivity Kit | ||
| ***Salinity:*** [Atlas Scientific Conductivity K 1.0 Kit](https://files.atlas-scientific.com/EC_EZO_Datasheet.pdf) | ||
| - EZO™ EC Circuit | ||
| - Conductivity Probe: 5 µS/cm to 200,000 µS/cm | ||
| - Electrically Isolated EZO™ Carrier Board | ||
|
|
||
| **Other EZO probes that should work but not yet tested:** | ||
| *Dissolved Oxygen, Pump, Humidity, Carbon Dioxide, Temperture* | ||
|
|
||
| ### Circuit Diagram | ||
| [See Wiki](https://github.com/TheRealFalseReality/aquapi/wiki/Circuit) for more details on the circuit. | ||
| <details> | ||
| <summary>See Diagram</summary> | ||
|
|
||
|  | ||
| ***Pump:*** [Atlas Scientific Pump Basic Kit](https://files.atlas-scientific.com/EZO_PMP_Datasheet.pdf) | ||
| - EZO™ Pump Embedded Circuit | ||
| - Flow Rate: 0.5ml to 105ml/mins | ||
|
|
||
| </details> | ||
| **Other EZO probes that should work but not yet tested:** | ||
| [Dissolved Oxygen](https://files.atlas-scientific.com/LG_DO_probe.pdf), [Humidity](https://files.atlas-scientific.com/EZO-HUM-Datasheet.pdf), | ||
| [Carbon Dioxide](https://files.atlas-scientific.com/EZO_CO2_Datasheet.pdf), | ||
| [ORP](https://files.atlas-scientific.com/orp_probe.pdf), | ||
| [Temperture](https://files.atlas-scientific.com/EZO_RTD_Datasheet.pdf) | ||
|
|
||
| **Prerequisite!!** A Raspberry Pi (or something similar) running HomeAssistant to communicate and interact with the ESP32 via `homeassistant.local:8123`. | ||
| Get [Raspberry Pi Imager](https://www.raspberrypi.com/software/) | ||
|
|
||
| ## Software Used | ||
| [**Home Assistant**](https://www.home-assistant.io/): Open source home automation that puts local control and privacy first. | ||
| [**ESPHome**](https://esphome.io/): A system to control your ESP8266/ESP32 and RP2040 by simple yet powerful configuration files and control them remotely through Home Automation systems. | ||
|
|
||
|  | ||
|
|
||
|
|
||
| ## Setup AquaPi | ||
| **[See Wiki](https://github.com/TheRealFalseReality/aquapi/wiki/Setup-AquaPi)** for Setup Guides that Include: | ||
|
|
||
| ### Home Assistant | ||
| Setting up Home Assistant and Connecting AquaPi to your Wifi. | ||
|
|
||
| ### Update Wirelessly | ||
| Updating the AquaPi. | ||
|
|
||
| ### Web Server | ||
| Connecting to the AquaPi without Home Assisstant. | ||
|
|
||
| ## Blueprints | ||
| **[See Wiki](https://github.com/TheRealFalseReality/aquapi/wiki/Blueprints)** | ||
| These are scripts and automations I created to control other devices within Home Assistant. | ||
|
|
||
| ## Install | ||
| **[See Wiki](https://github.com/TheRealFalseReality/aquapi/wiki/Install)** for guides when installing on a non-configured ESP32 device. | ||
|
|
||
| ## Notable Substitutions | ||
| **[See Wiki](https://github.com/TheRealFalseReality/aquapi/wiki/Substitutions)** for more information on customizing your device. | ||
|
|
||
| ## Useful Links: | ||
| <details> | ||
| <summary>See Links</summary> | ||
|
|
||
| [**HomeAssistant**](https://www.home-assistant.io/installation/) | ||
| [**ESPHome**](https://esphome.io/) | ||
| [**AtlasIoT Installation Guide**](https://files.atlas-scientific.com/How-to-install-Atlas-iot-software.pdf) | ||
| [**EZO Raspberry Pi Sample Code**](https://files.atlas-scientific.com/pi_sample_code.pdf) | ||
| [**EZO pH Circuit Datasheet**](https://files.atlas-scientific.com/pH_EZO_Datasheet.pdf) | ||
| [**EZO EC Circuit Datasheet**](https://files.atlas-scientific.com/EC_EZO_Datasheet.pdf) | ||
| [**EZO Pump Circuit Datasheet**](https://files.atlas-scientific.com/EZO_PMP_Datasheet.pdf) | ||
|
|
||
| </details> |