thek4n/pump_controller_web
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix docs

Browse Source
This commit is contained in:
thek4n 2026-06-07 21:36:06 +03:00
parent 63f0410c3b
commit 243a74ef74
1 changed files with 19 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@ -1,5 +1,5 @@
# 🚀 Pump Controller ESP32 # Pump Controller ESP32
## Web-Controlled Smart Pump System Web-Controlled Smart Pump System
<div align="center"> <div align="center">
<img src="./.gitassets/index.jpg" alt="Main page" width="300"> <img src="./.gitassets/index.jpg" alt="Main page" width="300">
@ -11,20 +11,21 @@
--- ---
## ✨ Features ## Features
- 📡 Web-based pressure monitoring - Web-based pressure monitoring
- 🔧 OTA-ready & configurable via browser - OTA-ready & configurable via browser
- 💡 LED status indicators - Auto-reset & fail-safe AP mode
- 🔁 Auto-reset & fail-safe AP mode
- 🧠 Non-volatile memory for settings
--- ---
## 🛠️ Build & Flash ## 🛠️ Build & Flash
> 💡 *Requires ESP-IDF framework and `just` task runner* > [!IMPORTANT]
>
> *Requires ESP-IDF framework and `just` task runner*
```bash Connect your esp32 and run:
```sh
PORT="/dev/ttyUSB0" \ PORT="/dev/ttyUSB0" \
ESP_IDF="~/playground/esp-idf/" ESP_IDF="~/playground/esp-idf/"
just build flash just build flash
@ -33,29 +34,31 @@ just build flash
--- ---
## 🌐First-Time Setup ## First-Time Setup
On **first boot**, the device creates a captive Wi-Fi access point: On **first boot**, the device creates a captive Wi-Fi access point:
- **SSID:** `pumpcontroller` - **SSID:** `pumpcontroller`
- **IP:** `192.168.4.1` - **IP:** `192.168.4.1`
- **Port:** `80` - **Port:** `80`
### Steps: ### Steps:
1. Connect to `pumpcontroller` Wi-Fi 1. Connect to `pumpcontroller` Wi-Fi
2. Open browser → `http://192.168.4.1` 2. Open browser -> `http://192.168.4.1`
3. Enter your **home Wi-Fi SSID + password** 3. Enter your **home Wi-Fi SSID + password**
4. Device reboots → joins your network 4. Device reboots → joins your network
5. Find its IP in your router's DHCP list 5. Find its IP in your router's DHCP list
✅ That IP becomes your **pump control dashboard** 🎯 That IP becomes your **pump control dashboard**
> ⚠️ If you enter wrong credentials, the device will **not** connect. > [!WARNING]
>
> If you enter wrong credentials, the device will **not** connect.
> You’ll need to **factory reset** and try again. > You’ll need to **factory reset** and try again.
--- ---
## 🔄 Factory Reset ## Factory Reset
1. **Short pin `D15` to GND** 1. **Short pin `D15` to GND**
2. **Power on** the device 2. **Power on** the device
3. LED blinks **3 times** 🔴🔴🔴 3. LED blinks **3 times** 🔴🔴🔴