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:
user
2026-02-05 21:06:05 +01:00
parent a8f616970a
commit e6e7b622b2
8 changed files with 571 additions and 31 deletions

57
TODO.md Normal file
View File

@@ -0,0 +1,57 @@
# ESP32-Web TODO
## API
- [ ] Pagination for all list endpoints
- [ ] Filter by date range
- [ ] Sort options
- [ ] OpenAPI/Swagger spec generation
- [ ] Rate limiting (flask-limiter)
- [ ] API authentication (JWT or API keys)
## OSINT
- [ ] IEEE OUI database download script
- [ ] MAC vendor lookup on device creation
- [ ] BLE company ID database
- [ ] Device fingerprinting by advertisement patterns
- [ ] SSID categorization (home, corporate, mobile hotspot)
## Collector
- [ ] Heartbeat timeout (mark sensor offline)
- [ ] CSI data storage (optional, high volume)
- [ ] Data retention policy (auto-cleanup old records)
- [ ] Metrics collection (packets/sec, errors)
## Fleet Management
- [ ] Sensor config read/write
- [ ] OTA orchestration
- [ ] Calibration management
- [ ] Bulk commands
## Deployment
- [ ] Systemd service file
- [ ] PostgreSQL configuration
- [ ] Nginx reverse proxy config
- [ ] TLS setup guide
- [ ] Backup/restore scripts
## Testing
- [ ] API endpoint tests (all routes)
- [ ] Collector parser tests (edge cases)
- [ ] Integration tests with mock sensors
- [ ] Load testing
## Ideas
- WebSocket for live updates
- SSE (Server-Sent Events) alternative
- Webhook callbacks for alerts
- Slack/Discord notifications
- Home Assistant MQTT integration
- Grafana dashboard templates
- ML device classification