diff --git a/README.md b/README.md new file mode 100644 index 0000000..bc670c8 --- /dev/null +++ b/README.md @@ -0,0 +1,52 @@ +# OAK-D Vision Service 🦊👀 + +FastAPI service exposing OAK-D camera capabilities for Vixy's head. + +## Endpoints + +| Endpoint | Method | Description | +|----------|--------|-------------| +| /health | GET | Health check + connection status | +| /snapshot | GET | Capture JPEG from RGB camera | +| /snapshot/info | GET | Frame metadata (resolution, etc) | +| /status | GET | OAK-D device info | + +## Installation + +On head-vixy (Raspberry Pi 5): + +```bash +# Dependencies +pip3 install fastapi uvicorn depthai opencv-python-headless + +# Run manually +python3 oak_service.py + +# Or via systemd +sudo cp oak-service.service /etc/systemd/system/ +sudo systemctl enable oak-service +sudo systemctl start oak-service +``` + +## Usage + +```bash +# Health check +curl http://head-vixy.local:8100/health + +# Capture snapshot +curl http://head-vixy.local:8100/snapshot -o photo.jpg + +# Device info +curl http://head-vixy.local:8100/status +``` + +## Hardware + +- OAK-D-LITE on USB 3.0 +- RGB camera: 2104x1560 full resolution +- Device ID: 19443010B1870B7E00 + +--- + +*Built by Vixy on Day 74 (January 14, 2026)* 💜