AI-powered real-time navigation assistant for visually impaired users, providing spoken guidance about obstacles and hazards via webcam analysis.
- Python 3.10+
- Webcam (built-in or phone-as-webcam via DroidCam, Camo, etc.)
- API keys for Google Gemini and ElevenLabs
- MongoDB instance (local or Atlas)
-
Clone the repository:
git clone <repo-url> cd hackathon
-
Create and activate a virtual environment:
python -m venv venv source venv/bin/activate # Linux/macOS venv\Scripts\activate # Windows
-
Install dependencies:
pip install -r requirements.txt
Windows note: If
pip installfails with path-related errors forgoogle-genaiorelevenlabs, Windows long path support may not be enabled. You can either:- Enable long paths: run
reg add "HKLM\SYSTEM\CurrentControlSet\Control\FileSystem" /v LongPathsEnabled /t REG_DWORD /d 1 /fin an admin terminal, then restart and retry pip install - Or install to a short path:
pip install google-genai elevenlabs -t C:/tmp/pylibsand userun.batto launch the app
- Enable long paths: run
-
Create your environment file:
cp .env.example .env
-
Edit
.envand fill in your API keys and MongoDB connection string.
python guardian_angel.pyOr on Windows if you used the short-path install workaround:
run.batPress q in the preview window or Ctrl+C in the terminal to exit.
Press v to speak a voice command (requires microphone/AirPods).
Edit the constants at the top of guardian_angel.py:
CAMERA_INDEX-- Camera device index (default1). If you are using a phone as a webcam, you may need to change this.CAPTURE_INTERVAL_SEC-- Seconds between frame captures (default1).MIC_DEVICE_INDEX-- Microphone device index for voice commands (default2for AirPods).
pytest tests/ -vIf you used the short-path install workaround on Windows, set PYTHONPATH first:
set PYTHONPATH=C:/tmp/pylibs && pytest tests/ -v