docs: Add project documentation
- README.md: Quick start, API endpoints, ports - PROJECT.md: Architecture, components, data models - ROADMAP.md: Version milestones (v0.1.x - v1.0.0) - TASKS.md: Current sprint tasks - TODO.md: Backlog items - docs/INSTALL.md: Setup and deployment - docs/USAGE.md: API examples - docs/CHEATSHEET.md: Quick reference
This commit is contained in:
54
ROADMAP.md
Normal file
54
ROADMAP.md
Normal file
@@ -0,0 +1,54 @@
|
||||
# ESP32-Web Roadmap
|
||||
|
||||
## v0.1.0 - Project Scaffold [DONE]
|
||||
|
||||
- [x] Flask app factory with blueprints
|
||||
- [x] SQLAlchemy models (Sensor, Device, Sighting, Alert, Event, Probe)
|
||||
- [x] UDP collector for sensor data streams
|
||||
- [x] Core API endpoints
|
||||
- [x] pytest setup
|
||||
- [x] Containerfile + Makefile
|
||||
|
||||
## v0.1.1 - Server Management [DONE]
|
||||
|
||||
- [x] start/stop/restart/status via Makefile
|
||||
- [x] Health endpoint with uptime
|
||||
- [x] Database migrations (Flask-Migrate)
|
||||
- [x] Listen on all interfaces
|
||||
|
||||
## v0.2.0 - OSINT Features
|
||||
|
||||
- [ ] MAC vendor lookup (IEEE OUI database)
|
||||
- [ ] BLE company_id to manufacturer mapping
|
||||
- [ ] Device profile enrichment
|
||||
- [ ] Export endpoints (CSV, JSON)
|
||||
|
||||
## v0.3.0 - Fleet Management
|
||||
|
||||
- [ ] Sensor config endpoint (GET/PUT)
|
||||
- [ ] OTA trigger endpoint
|
||||
- [ ] Calibration trigger endpoint
|
||||
- [ ] Sensor history/metrics
|
||||
|
||||
## v0.4.0 - Zones & Presence
|
||||
|
||||
- [ ] Zone management (assign sensors to areas)
|
||||
- [ ] Device zone tracking
|
||||
- [ ] Dwell time analysis
|
||||
- [ ] Presence history
|
||||
|
||||
## v1.0.0 - Production Ready
|
||||
|
||||
- [ ] Authentication (API keys or JWT)
|
||||
- [ ] Rate limiting
|
||||
- [ ] PostgreSQL support
|
||||
- [ ] Systemd service file
|
||||
- [ ] Production deployment guide
|
||||
|
||||
## Future
|
||||
|
||||
- WebSocket for real-time updates
|
||||
- Web dashboard (htmx + Pico CSS)
|
||||
- Home Assistant integration
|
||||
- Grafana dashboards
|
||||
- Webhook callbacks for alerts
|
||||
Reference in New Issue
Block a user