diff --git a/README.md b/README.md index 4699433..254d80d 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -# π Pump Controller ESP32 -## Web-Controlled Smart Pump System +# Pump Controller ESP32 +Web-Controlled Smart Pump System
@@ -11,20 +11,21 @@
---
-## β¨ Features
-- π‘ Web-based pressure monitoring
-- π§ OTA-ready & configurable via browser
-- π‘ LED status indicators
-- π Auto-reset & fail-safe AP mode
-- π§ Non-volatile memory for settings
+## Features
+- Web-based pressure monitoring
+- OTA-ready & configurable via browser
+- Auto-reset & fail-safe AP mode
---
## π οΈ 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" \
ESP_IDF="~/playground/esp-idf/"
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:
-
- **SSID:** `pumpcontroller`
- **IP:** `192.168.4.1`
- **Port:** `80`
+
### Steps:
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**
4. Device reboots β joins your network
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.
---
-## π Factory Reset
+## Factory Reset
1. **Short pin `D15` to GND**
2. **Power on** the device
3. LED blinks **3 times** π΄π΄π΄