This guide is written for absolute beginners. Follow each step in order.
1. Introduction to PumpPilot
PumpPilot is a smart motor control platform for fair and safe pump usage.
- One Admin controls one pump line with many users.
- System handles wallet minutes, queue, and load shedding automatically.
- ESP32 follows server command every few seconds.
2. Account Login and Access
Choose the correct role before login: Master Admin, Admin, or User.
- User and Admin can register from Home page.
- New Admin may stay pending until Master Admin approval.
- If login fails, check role + username + password.
Example: Admin 'Rahim' registers -> status pending -> Master approves -> then login works.
3. Understanding the Dashboard
Dashboard cards show real-time motor and wallet state.
- Motor Status: OFF / RUNNING / HOLD
- OFF means the motor is stopped.
- RUNNING means the motor is active.
- HOLD means the session is paused for safety and may resume automatically.
- Remaining Minutes: current running timer
- Available Minutes: wallet balance
- Queue cards appear only when user is queued
4. Check Balance Before Start
Always check your available balance before trying to run the motor.
- A minimum usable balance is required before start is allowed.
- If the balance is too low, the system blocks the start request.
- Recharge or request minutes first, then try again.
- Available Minutes shows your current wallet balance.
Example: If your balance is too low, the Start action will not continue until more minutes are added.
5. Getting Minutes Recharge
User requests minutes; Admin approves/recharges from Admin Dashboard.
- User clicks Buy Minutes and sends request.
- Admin sees pending request and can Approve/Decline.
- Approved minutes are added instantly to user wallet.
6. How to Start the Pump
Choose your run time and start the motor from the User Dashboard.
- Enter the number of minutes you want to use.
- Press Start Motor to send the request.
- If the pump is already busy, you are placed in queue automatically.
- If the start is accepted, the dashboard changes to RUNNING.
Example: If another user is already running the pump, your queue position is shown instead of immediate start.
7. How to Stop the Pump
You can stop an active run or cancel your queued request from the dashboard.
- If you are RUNNING, the motor stops and the session is finalized.
- If you are waiting in queue, your pending request is removed.
- After stop, the dashboard returns to the normal OFF view.
8. How Balance Updates After a Run
When a run ends, PumpPilot updates the final balance automatically.
- The system tracks active usage during the session.
- When the run ends early or reaches its stop condition, the final balance is recalculated automatically.
- The final safety balance is protected during stop conditions.
Example: A user starts a run, uses the pump for some time, and then stops. The wallet is updated automatically based on actual usage and current safety rules.
9. Adding Extra Minutes
When RUNNING, user can extend by +1 minute.
- Button appears only during RUNNING.
- Each click increases remaining time by 1 minute.
- Wallet is adjusted accordingly.
10. Understanding the Queue System
The queue allows only one active motor session per admin line.
- Position #1 waits for the current run to finish.
- Estimated wait depends on the current run and earlier queued users.
- The next user starts automatically when the current run ends.
Example: If one user is already running, the next user sees queue position and waits for automatic start.
11. RFID Card Mode
RFID mode lets an assigned card start a session for its linked user.
- An assigned RFID card starts the motor for its linked account.
- While card mode is active, the dashboard shows that a card session is in use.
- When the session ends or reaches its stop condition, the motor stops automatically.
- Card mode follows the same safety rules as normal sessions.
12. HOLD and Recovery
For safety, the system can pause a session without losing the active run.
- If load shedding starts, the motor goes to HOLD.
- If the device becomes not ready, the session can also move to HOLD.
- HOLD is a protection state, not a normal stop.
- When normal conditions return, the session can continue from the remaining time.
Example: A running session moves to HOLD because the device is not ready. When the device becomes ready again, the motor can resume from the remaining time.
13. Viewing Usage History
Use Logs page to track activity.
- See motor_start, motor_stop, recharge, hold, resume, and queue events.
- Master sees all logs, Admin sees own logs, User sees own logs.
- Logs are useful for support, review, and billing checks.
14. Common Problems and Solutions
If something does not work, check these items in order.
- Check internet or device connectivity first.
- Check whether the device is ready.
- Check load shedding status.
- Check wallet balance and queue position.
- Check account status if start is still blocked.
15. Safety Guidelines
Follow electrical and operational safety at all times.
- Do not bypass interlock or relay protection.
- Use proper rated contactor/relay and wiring.
- Keep panel dry and protected from dust/water.
16. Best Usage Practices
Good habits improve uptime and reduce disputes.
- Set realistic run minutes, avoid oversized requests.
- Approve/decline requests quickly to keep workflow smooth.
- Review logs weekly for unusual behavior.
- Protect credentials, secrets, and device access.