- name
- voice-assistant
- description
- >
- metadata
Voice Assistant for OpenClaw
A Python companion app that gives OpenClaw a voice. Say a wake word (or press a hotkey), speak naturally, and hear the AI respond — then keep talking for multi-turn conversation.
Mic → Porcupine wake word → faster-whisper STT → OpenClaw Gateway → ElevenLabs TTS → SpeakerQuick Start
# 1. Navigate to the skill scripts
cd {baseDir}/scripts
# 2. Create a virtual environment and install dependencies
python -m venv venv
venv\Scripts\pip install -r requirements.txt
# 3. Copy .env.example to .env and fill in your keys
copy .env.example .env
# 4. Run the assistant
venv\Scripts\python src\assistant.pyRequirements
| Service | What you need | Cost |
|---|---|---|
| OpenClaw gateway | Running locally on ws://127.0.0.1:18789 with a gateway token | — |
| ElevenLabs | API key + voice ID (free tier works with default voices) | Free+ |
| Picovoice | Access key from picovoice.ai (free tier works) | Free |
| Python | 3.10+ (tested on 3.14) | — |
| Microphone | Any input device | — |
Configuration (.env)
# OpenClaw Gateway
GATEWAY_URL=ws://127.0.0.1:18789
GATEWAY_TOKEN=your-gateway-token
# ElevenLabs TTS
ELEVENLABS_API_KEY=your-api-key
ELEVENLABS_VOICE_ID=XrExE9yKIg1WjnnlVkGX # Matilda (free tier) — or MClEFoImJXBTgLwdLI5n for Ivy (paid)
ELEVENLABS_MODEL_ID=eleven_v3
# Porcupine Wake Word
PORCUPINE_ACCESS_KEY=your-access-key
PORCUPINE_MODEL_PATH= # path to custom .ppn file (optional)
# Whisper STT
WHISPER_MODEL=base # tiny, base, small, medium, large
# Tuning
WAKE_SENSITIVITY=0.7 # 0.0–1.0 (higher = more sensitive)
SILENCE_TIMEOUT=1.5 # seconds of silence to stop recording
HOTKEY=ctrl+shift+k # global keyboard shortcutCustom Wake Word
- Go to Picovoice Console
- Create a custom wake word (e.g. "Hey Claudia", "Hey OpenClaw")
- Download the
.ppnfile for your platform - Set
PORCUPINE_MODEL_PATHin.envto the file path - Without a custom model, falls back to built-in "hey google"
Personalized Voice Sounds
The assistant plays short audio clips when activated ("Yep!", "Hi!") and while thinking ("Hmm...", "Let me think..."). Generate these in your chosen ElevenLabs voice:
cd {baseDir}/scripts
venv\Scripts\python generate_chime_sounds.py
venv\Scripts\python generate_thinking_sounds.pyRe-run these after changing ELEVENLABS_VOICE_ID.
Running in Background
Use start.bat to launch without a console window (runs via pythonw.exe). The assistant appears as a system tray icon with Pause/Resume/Quit controls.
For auto-start on Windows, create a shortcut to start.bat in shell:startup.
How It Works
- Wake — Porcupine detects the wake word (or user presses hotkey)
- Chime — Plays a random activation sound ("Yep!", "Hi!")
- Record — Records speech until 1.5s of silence (2s grace period for initial silence)
- Thinking — Plays a filler sound ("Hmm...", "Let me think...")
- Transcribe — faster-whisper converts audio to text locally (CPU, int8)
- Gateway — Sends text to OpenClaw gateway via WebSocket, streams response
- Speak — ElevenLabs converts response to speech, plays through speakers
- Follow-up — Automatically listens for 5s after speaking for conversation continuity
- Idle — Returns to wake word listening after 5s of silence
Mic suppression keeps the microphone muted during all speaker output to prevent feedback loops.
Detailed Architecture
See references/architecture.md for source file breakdown, WebSocket protocol details, and audio pipeline internals.
Troubleshooting
See references/troubleshooting.md for common issues with mic detection, gateway connection, TTS errors, and wake word tuning.