Skip to content

Commit 08a7237

Browse files
committed
Update parent workspace README
1 parent 96827a5 commit 08a7237

File tree

1 file changed

+27
-14
lines changed

1 file changed

+27
-14
lines changed

coffee_ws/README.md

Lines changed: 27 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -400,40 +400,53 @@ Sui Blockchain → Indexer → /sui_events → Coffee Controller → /coffee_com
400400

401401
## Launching Voice Agent (NEW)
402402

403-
### Coffee Voice Agent ROS2 Node
404-
The new integrated voice agent that combines LiveKit voice communication with ROS2:
403+
### Coffee Voice Agent with Bridge Architecture
404+
The voice agent runs as a standalone console application with optional ROS2 integration via bridge:
405405

406406
```bash
407407
# Build the voice agent package
408408
colcon build --packages-select coffee_voice_agent
409409
source install/setup.bash
410410

411-
# Run the voice agent
412-
ros2 launch coffee_voice_agent voice_agent.launch.py
411+
# 🚀 STEP 1: Run Voice Agent (Console Mode - Required)
412+
./src/coffee_voice_agent/scripts/run_main.sh # Refactored version (recommended)
413+
# OR
414+
./src/coffee_voice_agent/scripts/run_voice_agent_original.sh # Original version (reference)
413415

414-
# Or run directly
415-
ros2 run coffee_voice_agent voice_agent_node
416+
# 🌐 STEP 2: ROS2 Integration (Optional Bridge)
417+
ros2 launch coffee_voice_agent voice_agent_bridge.launch.py # Bridge only
418+
# OR
419+
ros2 launch coffee_voice_agent voice_agent_system.launch.py # Complete system
416420
```
417421

422+
**Architecture:**
423+
- **Voice Agent**: Standalone console application (interactive controls)
424+
- **Bridge Node**: Optional ROS2 integration via WebSocket (port 8080)
425+
- **Communication**: WebSocket bridge connects standalone agent to ROS2
426+
418427
**Features:**
419-
- Wake word detection ("hey barista")
428+
- Wake word detection ("hey barista")
420429
- Full voice conversation (STT, LLM, TTS)
421430
- Emotion-aware responses
422431
- Coffee menu and recommendations
423-
- ROS2 integration with Coffee Buddy system
432+
- Console controls (`[Ctrl+B]`, `[Q]`)
433+
- ROS2 integration via bridge
424434
- Virtual request handling
425435

426-
**Topics:**
427-
- `/coffee_voice_agent/state` - Agent state
428-
- `/coffee_voice_agent/emotion` - Current emotion
429-
- `/coffee_voice_agent/user_input` - User speech
430-
- `/coffee_voice_agent/agent_response` - Agent responses
431-
- `/coffee_voice_agent/virtual_request` - External requests
436+
**ROS2 Topics (Bridge Node):**
437+
- `/voice_agent/state` - Agent state changes
438+
- `/voice_agent/emotion` - Current emotion transitions
439+
- `/voice_agent/conversation` - Conversation transcripts
440+
- `/voice_agent/connected` - Bridge connection status
441+
- `/voice_agent/virtual_requests` - External coffee requests (input)
442+
- `/voice_agent/commands` - Voice agent commands (input)
432443

433444
**Requirements:**
434445
- `OPENAI_API_KEY` environment variable
435446
- `PORCUPINE_ACCESS_KEY` for wake word (optional)
436447

448+
**Note:** Voice agent must run in console mode due to interactive controls requirement. ROS2 bridge provides system integration while preserving console functionality.
449+
437450
## Launching Dialogue System (Legacy)
438451

439452
### TTS Node

0 commit comments

Comments
 (0)