camera
Project Status Tracker
✈️ Table of Pages
Below is a quick reference table of the main documentation pages.
| Page | Description |
|---|---|
| What Sets it Apart | Why you should just do it yourself and the cost |
| MVP | High level project goals and summary |
| Status Tracker | Feature progress table |
| Unit Testing | Test and coverage instructions |
| Build It Yourself | Clone & Docker setup guide |
| Firmware | Firmware API reference |
| Hub Guide | Hub API reference |
| Communication Methods | Communication and architecture |
This table tracks high-level progress across firmware, UI, and hub components.
| Feature | Status |
|---|---|
| ESP32 firmware first boot flow | ✅ Done |
| FastAPI authentication & camera registry | ✅ Done |
| Vue UI core navigation | ✅ Done |
| UI login flow & auth guard | ✅ Done |
| Real-time streaming & photo capture | ✅ Done |
| First boot WiFi scan portal | ✅ Done |
| Diagnostics & speed test UI | ✅ Done |
| USB composite CDC/MSC interface | ✅ Done |
| Full FastAPI camera endpoints & WebSocket relay | ✅ Done |
| Local USB camera service (Node.js) | ✅ Done |
| OTA updates with rollback support | ✅ Done |
| Battery stats reporting with UI display | ✅ Done |
| Hub Docker packaging | ✅ Done |
| Docker setup docs | ✅ Done |
| AI-based smart motion detection | ✅ Done |
| Customizable motion zones | ✅ Done |
| MQTT/Home Assistant integration | ✅ Done |
| Mobile-friendly progressive web app (PWA) | ✅ Done |
| Detailed quick-setup guides | ✅ Done |
Engineering Backlog Checklist
- Fix
pi/tests/test_websocket.py::test_websocket_relayhang so full backend suite exits cleanly. - Add timeout-safe WebSocket test harness pattern to prevent CI deadlock.
- Run full backend test suite end-to-end after WebSocket fix and keep it green.
- Add
pytest.iniasyncio loop-scope setting to removepytest-asynciodeprecation warning. - Replace backend
datetime.utcnow()usage with timezone-aware UTC datetimes. - Stop returning password reset tokens from
/api/auth/reset-request; use generic responses, out-of-band delivery, expiry, tests, and docs. - Require explicit admin credential setup outside development; gate default credentials behind an opt-in dev flag and document required env vars.
- Migrate backend password storage from salted SHA-256 to bcrypt, with legacy hash migration tests.
- Expand UI unit tests for router auth guard and login flow.
- Add role-aware frontend route guards for admin-only screens such as
/users,/integrations, and/api-docs. - Surface OTP enrollment in the UI when
/api/auth/loginreturnsotp_qr, including tests and docs. - Add API integration tests for
/api/integrations,/api/auth/refresh, and/api/system-metrics. - Expand firmware test coverage for failover (
ssid_backup,fallback_ap) and passphrase reset edge cases. - Complete OTA updates with rollback support.
- Implement battery stats reporting end-to-end (firmware -> hub -> UI).
- Implement smart motion confidence pipeline.
- Implement configurable motion zones with backend validation.
- Implement mobile-friendly progressive web app (PWA) path.
- Publish detailed quick-setup guides for Windows, Linux, and macOS.
- Audit and update Node/Python dependencies.
- Resolve
npm auditfindings inuiwith safe upgrades. - Keep
docs/CHANGELOG.md,docs/status_tracker.md, anddocs/glossary.mdsynchronized after each feature batch. - Break backlog items into implementation-ready issues with owner area, affected paths, expected tests, and acceptance criteria.
- Add ESP Web Tools so admins can image devices from the server.
Detailed Descriptions of Completed Features:
- ESP32 Firmware First Boot Flow: Automatic initialization, including setup of initial Wi-Fi configuration and local server hosting for immediate camera accessibility.
- FastAPI Authentication & Camera Registry: Secure JWT-based authentication supporting multiple user roles (Admin, Super, Viewer) and centralized registration and management of connected cameras.
- Vue UI Core Navigation: Responsive, intuitive web interface with clear navigation, providing seamless access to camera streams, configuration settings, and diagnostic tools.
- UI Login Flow & Auth Guard: Secure login flow enforced by role-based permissions to restrict access to critical camera settings and administrative functions.
- Real-time Streaming & Photo Capture: Robust WebSocket-based real-time streaming service delivering low-latency MJPEG video streams, complemented by instant photo-capture capabilities.
- First Boot WiFi Scan Portal: Automatic Wi-Fi network detection and user-friendly selection interface during the initial setup, simplifying the network connection process.
- Diagnostics & Speed Test UI: Comprehensive diagnostics including Wi-Fi signal strength, storage availability, camera connectivity, and built-in bandwidth testing to ensure optimal system performance.
- USB Composite CDC/MSC Interface: Provides simultaneous USB serial communication (CDC) and mass storage capabilities (MSC), facilitating convenient configuration and file transfers.
- Full FastAPI Camera Endpoints & WebSocket Relay: Extensive RESTful APIs for camera control, configuration management, and a secure WebSocket relay for encrypted streaming.
- Local USB Camera Service (Node.js): Enables external USB camera integration for additional flexibility, capturing and forwarding video frames seamlessly to the hub backend.
- Encrypted Wi-Fi Credentials & Failover: Passwords are stored encrypted on the SD card. The firmware retries a backup network and can automatically start its own AP if all connections fail.
- Hub Docker Packaging & Setup Docs: Automated script builds the UI, prepares certs and generates a ready Docker image with updated instructions.
- Integration Accounts & System Metrics: New user role for third-party automation and
/api/system-metricsdiagnostics endpoint. - Account Lockout with OTP Recovery: Login failures now trigger temporary and permanent lockouts with admin OTP-based recovery.